AWSPowerShell.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWSPowerShell</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AS.AddASInstancesCmdlet"> <summary> Attaches one or more EC2 instances to the specified Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.PowerShell.Common.ServiceCmdlet"> <summary> Base class for all AWS cmdlets that interact with an AWS service in some way and thus need region and credential support. </summary> </member> <member name="T:Amazon.PowerShell.Common.BaseCmdlet"> <summary> Ultimate base class for the AWS cmdlet hierarchy; adds helper methods for error and progress reporting. Cmdlets that need region or credential handling, or communicate with AWS services in any way, should derive from ServiceCmdlet. </summary> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.ThrowError(System.Exception)"> <summary> Summary to throw error based on inspection of the exception type. </summary> <param name="e"></param> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.ThrowArgumentError(System.String,System.Object)"> <summary> Helper to throw a terminating exception on detection of invalid argument(s) </summary> <param name="message">The message to emit to the error record</param> <param name="errorSource">The source (parameter or cmdlet) reporting the error</param> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.DisplayWarning(System.String)"> <summary> Displays the specified warning message in the shell. </summary> <param name="message"></param> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.ThrowArgumentError(System.String,System.Object,System.Exception)"> <summary> Helper to throw a terminating exception on detection of invalid argument(s) </summary> <param name="message">The message to emit to the error record</param> <param name="errorSource">The source (parameter or cmdlet) reporting the error</param> <param name="innerException">The exception that occurred processing the parameter, if any</param> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.ThrowExecutionError(System.String,System.Object,System.Exception)"> <summary> Helper to throw an error occuring during service execution </summary> <param name="message">The message to emit to the error record</param> <param name="errorSource">The source (parameter or cmdlet) reporting the error</param> <param name="innerException">The exception that was caught, if any</param> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.ConfirmShouldProceed(System.Boolean,System.String,System.String)"> <summary> Helper to call ShouldProcess, mixing in usage of a -Force flag (more commonly used with ShouldContinue, but we don't use that) to override prompting unless -WhatIf is specified. The switch settings -WhatIf and -Confirm are retrieved from the invocation, since they are added dynamically at runtime by the shell. </summary> <param name="force">True if the -Force switch has been set</param> <param name="resourceIdentifiersText">Formatted string containing the identifiers of the resources to be operated on.</param> <param name="operationName">The name of the operation to be run (usually cmdlet name plus service api name)</param> <returns>True if the operation should proceed</returns> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.FormatParameterValuesForConfirmationMsg(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Returns formatted string containing the target of the operation for use in confirmation messages. Collections are truncated to avoid message bloat. </summary> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.GetFirstAssignedParameterValue(System.String[])"> <summary> Inspects the bound parameters to return the first from the set that has a value. Used when we are overriding the output for otherwise-void output cmdlets for -PassThru and the user had a choice of parameters to specify to mean the same underlying object (eg Beanstalk's EnvironmentId or EnvironmentName). If no bound parameter is found, the routine yields null. </summary> <param name="parameterNames"></param> <returns></returns> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.ParameterWasBound(System.String)"> <summary> Returns true if the supplied value type parameter, which corresponds to a nullable value type in the execution context, was bound in our current invocation and therefore is safe to take the value from. </summary> <param name="parameterName"></param> <returns></returns> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.WriteProgressRecord(System.String,System.String,System.Nullable{System.Int32})"> <summary> Writes progress record to the shell. </summary> <param name="activity"></param> <param name="message"></param> <param name="percentComplete"></param> </member> <member name="M:Amazon.PowerShell.Common.BaseCmdlet.WriteProgressCompleteRecord(System.String,System.String)"> <summary> Writes progress completed record to the shell. </summary> <param name="activity"></param> <param name="message"></param> </member> <member name="M:Amazon.PowerShell.Common.ServiceCmdlet.WriteCredentialSourceDiagnostic(Amazon.PowerShell.Common.AWSPSCredentials)"> <summary> Safely emit a diagnostic message indicating where the credentials we are about to use originated from. </summary> <param name="awsPSCredentials"></param> </member> <member name="M:Amazon.PowerShell.Common.ServiceCmdlet.WriteCredentialSourceDiagnostic(System.String)"> <summary> Emit a diagnostic message indicating where the credentials we are about to use originated from. </summary> <param name="credentialSource"></param> </member> <member name="M:Amazon.PowerShell.Common.ServiceCmdlet.WriteRegionSourceDiagnostic(Amazon.PowerShell.Common.RegionSource,System.String)"> <summary> Emit a diagnostic message indicating where the credentials we are about to use originated from. </summary> <param name="regionSource"></param> <param name="regionValue"></param> </member> <member name="M:Amazon.PowerShell.Common.ServiceCmdlet.WriteRegionSourceDiagnostic(System.String,System.String)"> <summary> Emit a diagnostic message indicating where the credentials we are about to use originated from. </summary> <param name="regionSource"></param> <param name="regionValue"></param> </member> <member name="M:Amazon.PowerShell.Common.ServiceCmdlet.FormatCredentialSourceForDisplay(Amazon.PowerShell.Common.AWSPSCredentials)"> <summary> Translates enum into a friendlier 'from xxx' display string </summary> <param name="creds"></param> <returns></returns> </member> <member name="M:Amazon.PowerShell.Common.ServiceCmdlet.FormatRegionSourceForDisplay(Amazon.PowerShell.Common.RegionSource)"> <summary> Translates enum into a friendlier 'from xxx' display string </summary> <param name="source"></param> <returns></returns> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.AddASInstancesCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.AddASInstancesCmdlet.InstanceId"> <summary> <para> <para>One or more EC2 instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.AddASInstancesCmdlet.PassThru"> <summary> Returns the ids of the EC2 instances that were attached. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.AddASInstancesCmdlet.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.AS.AddASLoadBalancerCmdlet"> <summary> Attaches one or more load balancers to the specified Auto Scaling group. <para> To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-load-balancer-asg.html">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.AddASLoadBalancerCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.AddASLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>One or more load balancer names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.AddASLoadBalancerCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.AddASLoadBalancerCmdlet.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.AS.CompleteASLifecycleActionCmdlet"> <summary> Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result. <para> This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group: </para><ol><li>Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.</li><li>Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.</li><li>Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.</li><li>If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.</li><li><b>Complete the lifecycle action</b>.</li></ol><para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingPendingState.html">Auto Scaling Pending State</a> and <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingTerminatingState.html">Auto Scaling Terminating State</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.CompleteASLifecycleActionCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group for the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.CompleteASLifecycleActionCmdlet.LifecycleActionResult"> <summary> <para> <para>The action for the group to take. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.CompleteASLifecycleActionCmdlet.LifecycleActionToken"> <summary> <para> <para>A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.CompleteASLifecycleActionCmdlet.LifecycleHookName"> <summary> <para> <para>The name of the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.CompleteASLifecycleActionCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.CompleteASLifecycleActionCmdlet.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.AS.DisableASMetricsCollectionCmdlet"> <summary> Disables monitoring of the specified metrics for the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DisableASMetricsCollectionCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DisableASMetricsCollectionCmdlet.Metric"> <summary> <para> <para>One or more of the following metrics. If you omit this parameter, all metrics are disabled.</para><ul><li><para><code>GroupMinSize</code></para></li><li><para><code>GroupMaxSize</code></para></li><li><para><code>GroupDesiredCapacity</code></para></li><li><para><code>GroupInServiceInstances</code></para></li><li><para><code>GroupPendingInstances</code></para></li><li><para><code>GroupStandbyInstances</code></para></li><li><para><code>GroupTerminatingInstances</code></para></li><li><para><code>GroupTotalInstances</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DisableASMetricsCollectionCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DisableASMetricsCollectionCmdlet.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.AS.DismountASInstancesCmdlet"> <summary> Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/detach-instance-asg.html">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DismountASInstancesCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DismountASInstancesCmdlet.InstanceId"> <summary> <para> <para>One or more instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DismountASInstancesCmdlet.ShouldDecrementDesiredCapacity"> <summary> <para> <para>If <code>True</code>, the Auto Scaling group decrements the desired capacity value by the number of instances detached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DismountASInstancesCmdlet.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.AS.DismountASLoadBalancerCmdlet"> <summary> Removes one or more load balancers from the specified Auto Scaling group. <para> When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DismountASLoadBalancerCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DismountASLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>One or more load balancer names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DismountASLoadBalancerCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.DismountASLoadBalancerCmdlet.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.AS.EnableASMetricsCollectionCmdlet"> <summary> Enables monitoring of the specified metrics for the specified Auto Scaling group. <para> You can only enable metrics collection if <code>InstanceMonitoring</code> in the launch configuration for the group is set to <code>True</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnableASMetricsCollectionCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name or ARN of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnableASMetricsCollectionCmdlet.Granularity"> <summary> <para> <para>The granularity to associate with the metrics to collect. The only valid value is <code>1Minute</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnableASMetricsCollectionCmdlet.Metric"> <summary> <para> <para>One or more of the following metrics. If you omit this parameter, all metrics are enabled.</para><ul><li><para><code>GroupMinSize</code></para></li><li><para><code>GroupMaxSize</code></para></li><li><para><code>GroupDesiredCapacity</code></para></li><li><para><code>GroupInServiceInstances</code></para></li><li><para><code>GroupPendingInstances</code></para></li><li><para><code>GroupStandbyInstances</code></para></li><li><para><code>GroupTerminatingInstances</code></para></li><li><para><code>GroupTotalInstances</code></para></li></ul><para>Note that the <code>GroupStandbyInstances</code> metric is not enabled by default. You must explicitly request this metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnableASMetricsCollectionCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnableASMetricsCollectionCmdlet.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.AS.EnterASStandbyCmdlet"> <summary> Moves the specified instances into <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingInServiceState.html">Auto Scaling InService State</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnterASStandbyCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnterASStandbyCmdlet.InstanceId"> <summary> <para> <para>One or more instances to move into <code>Standby</code> mode. You must specify at least one instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnterASStandbyCmdlet.ShouldDecrementDesiredCapacity"> <summary> <para> <para>Specifies whether the instances moved to <code>Standby</code> mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to <code>Standby</code> mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.EnterASStandbyCmdlet.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.AS.ExitASStandbyCmdlet"> <summary> Moves the specified instances out of <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingInServiceState.html">Auto Scaling InService State</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.ExitASStandbyCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.ExitASStandbyCmdlet.InstanceId"> <summary> <para> <para>One or more instance IDs. You must specify at least one instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.ExitASStandbyCmdlet.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.AS.GetASAccountLimitsCmdlet"> <summary> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASAdjustmentTypeCmdlet"> <summary> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingGroupCmdlet"> <summary> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingGroupCmdlet.AutoScalingGroupName"> <summary> <para> <para>The group names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingGroupCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingGroupCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingInstanceCmdlet"> <summary> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingInstanceCmdlet.InstanceId"> <summary> <para> <para>One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingInstanceCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingInstanceCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASAutoScalingNotificationTypeCmdlet"> <summary> Describes the notification types that are supported by Auto Scaling. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASLaunchConfigurationCmdlet"> <summary> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASLaunchConfigurationCmdlet.LaunchConfigurationName"> <summary> <para> <para>The launch configuration names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASLaunchConfigurationCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to return with this call. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASLaunchConfigurationCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASLifecycleHooksCmdlet"> <summary> Describes the lifecycle hooks for the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASLifecycleHooksCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASLifecycleHooksCmdlet.LifecycleHookName"> <summary> <para> <para>The names of one or more lifecycle hooks.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASLifecycleHookTypesCmdlet"> <summary> Describes the available types of lifecycle hooks. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASLoadBalancerCmdlet"> <summary> Describes the load balancers for the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASLoadBalancerCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASLoadBalancerCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASLoadBalancerCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASMetricCollectionTypeCmdlet"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASNotificationConfigurationCmdlet"> <summary> Describes the notification actions associated with the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASNotificationConfigurationCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASNotificationConfigurationCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASNotificationConfigurationCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASPolicyCmdlet"> <summary> Describes the policies for the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASPolicyCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASPolicyCmdlet.PolicyName"> <summary> <para> <para>One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASPolicyCmdlet.PolicyType"> <summary> <para> <para>One or more policy types. Valid values are <code>SimpleScaling</code> and <code>StepScaling</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASPolicyCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to be returned with each call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASPolicyCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASScalingActivityCmdlet"> <summary> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScalingActivityCmdlet.ActivityId"> <summary> <para> <para>The activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If the <code>AutoScalingGroupName</code> parameter is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScalingActivityCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScalingActivityCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScalingActivityCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASScalingProcessTypeCmdlet"> <summary> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASScheduledActionCmdlet"> <summary> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScheduledActionCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScheduledActionCmdlet.EndTime"> <summary> <para> <para>The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScheduledActionCmdlet.ScheduledActionName"> <summary> <para> <para>Describes one or more scheduled actions. If you omit this list, the call describes all scheduled actions. If you specify an unknown scheduled action it is ignored with no error.</para><para>You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the <code>NextToken</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScheduledActionCmdlet.StartTime"> <summary> <para> <para>The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScheduledActionCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASScheduledActionCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASTagCmdlet"> <summary> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para><para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASTagCmdlet.Filter"> <summary> <para> <para>A filter used to scope the tags to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASTagCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of items to return with this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.GetASTagCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.GetASTerminationPolicyTypeCmdlet"> <summary> Describes the termination policies supported by Auto Scaling. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet"> <summary> Creates an Auto Scaling group with the specified name and attributes. <para> If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroup.html">Auto Scaling Groups</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group. This name must be unique within the scope of your AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.AvailabilityZone"> <summary> <para> <para>One or more Availability Zones for the group. This parameter is optional if you specify subnets using the <code>VPCZoneIdentifier</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.DefaultCooldown"> <summary> <para> <para>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.</para><para>The default is 300. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html">Understanding Auto Scaling Cooldowns</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.DesiredCapacity"> <summary> <para> <para>The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.HealthCheckGracePeriod"> <summary> <para> <para>The amount of time, in seconds, after an EC2 instance comes into service that Auto Scaling starts checking its health. During this time, any health check failures for the instance are ignored.</para><para>This parameter is required if you are adding an <code>ELB</code> health check. Frequently, new instances need to warm up, briefly, before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to match the expected startup period of your application.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-add-elb-healthcheck.html">Add an Elastic Load Balancing Health Check to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.HealthCheckType"> <summary> <para> <para>The service to use for the health checks. The valid values are <code>EC2</code> and <code>ELB</code>.</para><para>By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.InstanceId"> <summary> <para> <para>The ID of the EC2 instance used to create a launch configuration for the group. Alternatively, use the <code>LaunchConfigurationName</code> parameter to specify a launch configuration instead of an EC2 instance.</para><para>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-asg-from-instance.html">Create an Auto Scaling Group from an EC2 Instance</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.LaunchConfigurationName"> <summary> <para> <para>The name of the launch configuration. Alternatively, use the <code>InstanceId</code> parameter to specify an EC2 instance instead of a launch configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.LoadBalancerName"> <summary> <para> <para>One or more load balancers.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SetUpASLBApp.html">Load Balance Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.MaxSize"> <summary> <para> <para>The maximum size of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.MinSize"> <summary> <para> <para>The minimum size of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.PlacementGroup"> <summary> <para> <para>The name of the placement group into which you'll launch your instances, if any. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.Tag"> <summary> <para> <para>The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values: key=<i>value</i>, value=<i>value</i>, propagate=<i>true</i> or <i>false</i>. Value and propagate are optional parameters.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.TerminationPolicy"> <summary> <para> <para>One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-termination-policy.html">Choosing a Termination Policy for Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.VPCZoneIdentifier"> <summary> <para> <para>A comma-separated list of subnet identifiers for your virtual private cloud (VPC).</para><para>If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html">Auto Scaling and Amazon Virtual Private Cloud</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASAutoScalingGroupCmdlet.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.AS.NewASLaunchConfigurationCmdlet"> <summary> Creates a launch configuration. <para> If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/LaunchConfiguration.html">Launch Configurations</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.AssociatePublicIpAddress"> <summary> <para> <para>Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html">Auto Scaling and Amazon Virtual Private Cloud</a> in the <i>Auto Scaling Developer Guide</i>.</para><para>If you specify a value for this parameter, be sure to specify at least one subnet using the <i>VPCZoneIdentifier</i> parameter when you create your group. </para><para>Default: If the instance is launched into a default subnet, the default is <code>true</code>. If the instance is launched into a nondefault subnet, the default is <code>false</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.BlockDeviceMapping"> <summary> <para> <para>One or more mappings that specify how block devices are exposed to the instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.ClassicLinkVPCId"> <summary> <para> <para>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.ClassicLinkVPCSecurityGroup"> <summary> <para> <para>The IDs of one or more security groups for the VPC specified in <code>ClassicLinkVPCId</code>. This parameter is required if <code>ClassicLinkVPCId</code> is specified, and is not supported otherwise. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.EbsOptimized"> <summary> <para> <para>Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html">Amazon EBS-Optimized Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.InstanceMonitoring_Enabled"> <summary> <para> <para>If <code>True</code>, instance monitoring is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.IamInstanceProfile"> <summary> <para> <para>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</para><para>EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-iam-role.html">Launch Auto Scaling Instances with an IAM Role</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.ImageId"> <summary> <para> <para>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Finding an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.InstanceId"> <summary> <para> <para>The ID of the EC2 instance to use to create the launch configuration.</para><para>The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</para><para>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-lc-with-instanceID.html">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.InstanceType"> <summary> <para> <para> The instance type of the EC2 instance. For information about available instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes"> Available Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.KernelId"> <summary> <para> <para> The ID of the kernel associated with the AMI. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.KeyName"> <summary> <para> <para>The name of the key pair. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.LaunchConfigurationName"> <summary> <para> <para>The name of the launch configuration. This name must be unique within the scope of your AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.PlacementTenancy"> <summary> <para> <para>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC.</para><para>You must set the value of this parameter to <code>dedicated</code> if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to <code>default</code>).</para><para>If you specify a value for this parameter, be sure to specify at least one subnet using the <i>VPCZoneIdentifier</i> parameter when you create your group.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html">Auto Scaling and Amazon Virtual Private Cloud</a> in the <i>Auto Scaling Developer Guide</i>. </para><para>Valid values: <code>default</code> | <code>dedicated</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.RamdiskId"> <summary> <para> <para> The ID of the RAM disk associated with the AMI. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.SecurityGroup"> <summary> <para> <para>One or more security groups with which to associate the instances.</para><para>If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para><para>If your instances are launched into a VPC, specify security group IDs. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.SpotPrice"> <summary> <para> <para>The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US-SpotInstances.html">Launch Spot Instances in Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.UserData"> <summary> <para> <para>The user data to make available to the launched EC2 instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html">Instance Metadata and User Data</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para><para>At this time, launch configurations don't support compressed (zipped) user data files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the LaunchConfigurationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.NewASLaunchConfigurationCmdlet.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.AS.RemoveASAutoScalingGroupCmdlet"> <summary> Deletes the specified Auto Scaling group. <para> The group must have no instances and no scaling activities in progress. </para><para> To remove all instances before calling <code>DeleteAutoScalingGroup</code>, call <a>UpdateAutoScalingGroup</a> to set the minimum and maximum size of the Auto Scaling group to zero. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASAutoScalingGroupCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASAutoScalingGroupCmdlet.ForceDelete"> <summary> <para> <para>Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASAutoScalingGroupCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASAutoScalingGroupCmdlet.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.AS.RemoveASLaunchConfigurationCmdlet"> <summary> Deletes the specified launch configuration. <para> The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASLaunchConfigurationCmdlet.LaunchConfigurationName"> <summary> <para> <para>The name of the launch configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASLaunchConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the LaunchConfigurationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASLaunchConfigurationCmdlet.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.AS.RemoveASLifecycleHookCmdlet"> <summary> Deletes the specified lifecycle hook. <para> If there are any outstanding lifecycle actions, they are completed first (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating instances). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASLifecycleHookCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group for the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASLifecycleHookCmdlet.LifecycleHookName"> <summary> <para> <para>The name of the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASLifecycleHookCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASLifecycleHookCmdlet.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.AS.RemoveASNotificationConfigurationCmdlet"> <summary> Deletes the specified notification. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASNotificationConfigurationCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASNotificationConfigurationCmdlet.TopicARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASNotificationConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASNotificationConfigurationCmdlet.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.AS.RemoveASPolicyCmdlet"> <summary> Deletes the specified Auto Scaling policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASPolicyCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASPolicyCmdlet.PolicyName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASPolicyCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASPolicyCmdlet.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.AS.RemoveASScheduledActionCmdlet"> <summary> Deletes the specified scheduled action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASScheduledActionCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASScheduledActionCmdlet.ScheduledActionName"> <summary> <para> <para>The name of the action to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASScheduledActionCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASScheduledActionCmdlet.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.AS.RemoveASTagCmdlet"> <summary> Deletes the specified tags. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASTagCmdlet.Tag"> <summary> <para> <para>Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values are: Resource type = <i>auto-scaling-group</i>, Resource ID = <i>AutoScalingGroupName</i>, key=<i>value</i>, value=<i>value</i>, propagate=<i>true</i> or <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASTagCmdlet.PassThru"> <summary> Returns the value passed to the Tag parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.RemoveASTagCmdlet.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.AS.ResumeASProcessCmdlet"> <summary> Resumes the specified suspended Auto Scaling processes for the specified Auto Scaling group. To resume specific processes, use the <code>ScalingProcesses</code> parameter. To resume all processes, omit the <code>ScalingProcesses</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspend and Resume Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.ResumeASProcessCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.ResumeASProcessCmdlet.ScalingProcess"> <summary> <para> <para>One or more of the following processes:</para><ul><li><para><code>Launch</code></para></li><li><para><code>Terminate</code></para></li><li><para><code>HealthCheck</code></para></li><li><para><code>ReplaceUnhealthy</code></para></li><li><para><code>AZRebalance</code></para></li><li><para><code>AlarmNotification</code></para></li><li><para><code>ScheduledActions</code></para></li><li><para><code>AddToLoadBalancer</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.ResumeASProcessCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.ResumeASProcessCmdlet.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.AS.SetASDesiredCapacityCmdlet"> <summary> Sets the size of the specified Auto Scaling group. <para> For more information about desired capacity, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/WhatIsAutoScaling.html">What Is Auto Scaling?</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASDesiredCapacityCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASDesiredCapacityCmdlet.DesiredCapacity"> <summary> <para> <para>The number of EC2 instances that should be running in the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASDesiredCapacityCmdlet.HonorCooldown"> <summary> <para> <para>By default, <code>SetDesiredCapacity</code> overrides any cooldown period associated with the Auto Scaling group. Specify <code>True</code> to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASDesiredCapacityCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASDesiredCapacityCmdlet.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.AS.SetASInstanceHealthCmdlet"> <summary> Sets the health status of the specified instance. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASInstanceHealthCmdlet.HealthStatus"> <summary> <para> <para> The health status of the instance. Set to <code>Healthy</code> if you want the instance to remain in service. Set to <code>Unhealthy</code> if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASInstanceHealthCmdlet.InstanceId"> <summary> <para> <para>The ID of the EC2 instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASInstanceHealthCmdlet.ShouldRespectGracePeriod"> <summary> <para> <para>If the Auto Scaling group of the specified instance has a <code>HealthCheckGracePeriod</code> specified for the group, by default, this call will respect the grace period. Set this to <code>False</code>, if you do not want the call to respect the grace period associated with the group.</para><para>For more information, see the <code>HealthCheckGracePeriod</code> parameter description for <a>CreateAutoScalingGroup</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASInstanceHealthCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASInstanceHealthCmdlet.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.AS.SetASTagCmdlet"> <summary> Creates or updates tags for the specified Auto Scaling group. <para> A tag is defined by its resource ID, resource type, key, value, and propagate flag. The value and the propagate flag are optional parameters. The only supported resource type is <code>auto-scaling-group</code>, and the resource ID must be the name of the group. The <code>PropagateAtLaunch</code> flag determines whether the tag is added to instances launched in the group. Valid values are <code>true</code> or <code>false</code>. </para><para> When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASTagCmdlet.Tag"> <summary> <para> <para>One or more tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASTagCmdlet.PassThru"> <summary> Returns the collection of Tag objects that were created or updated. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SetASTagCmdlet.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.AS.StartASPolicyCmdlet"> <summary> Executes the specified policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StartASPolicyCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StartASPolicyCmdlet.BreachThreshold"> <summary> <para> <para>The breach threshold for the alarm.</para><para>This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StartASPolicyCmdlet.HonorCooldown"> <summary> <para> <para>If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.</para><para>This parameter is not supported if the policy type is <code>StepScaling</code>.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html">Understanding Auto Scaling Cooldowns</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StartASPolicyCmdlet.MetricValue"> <summary> <para> <para>The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.</para><para>If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.</para><para>This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StartASPolicyCmdlet.PolicyName"> <summary> <para> <para>The name or ARN of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StartASPolicyCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StartASPolicyCmdlet.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.AS.StopASInstanceInAutoScalingGroupCmdlet"> <summary> Terminates the specified instance and optionally adjusts the desired group size. <para> This call simply makes a termination request. The instance is not terminated immediately. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StopASInstanceInAutoScalingGroupCmdlet.InstanceId"> <summary> <para> <para>The ID of the EC2 instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StopASInstanceInAutoScalingGroupCmdlet.ShouldDecrementDesiredCapacity"> <summary> <para> <para>If <code>true</code>, terminating the instance also decrements the size of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.StopASInstanceInAutoScalingGroupCmdlet.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.AS.SuspendASProcessCmdlet"> <summary> Suspends the specified Auto Scaling processes for the specified Auto Scaling group. To suspend specific processes, use the <code>ScalingProcesses</code> parameter. To suspend all processes, omit the <code>ScalingProcesses</code> parameter. <para> Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly. </para><para> To resume processes that have been suspended, use <a>ResumeProcesses</a>. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspend and Resume Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SuspendASProcessCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SuspendASProcessCmdlet.ScalingProcess"> <summary> <para> <para>One or more of the following processes:</para><ul><li><para><code>Launch</code></para></li><li><para><code>Terminate</code></para></li><li><para><code>HealthCheck</code></para></li><li><para><code>ReplaceUnhealthy</code></para></li><li><para><code>AZRebalance</code></para></li><li><para><code>AlarmNotification</code></para></li><li><para><code>ScheduledActions</code></para></li><li><para><code>AddToLoadBalancer</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SuspendASProcessCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.SuspendASProcessCmdlet.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.AS.UpdateASAutoScalingGroupCmdlet"> <summary> Updates the configuration for the specified Auto Scaling group. <para> To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>. </para><para> The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected. </para><para> Note the following: </para><ul><li><para> If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>. </para></li><li><para> If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>. </para></li><li><para> All other optional parameters are left unchanged if not specified. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.AvailabilityZone"> <summary> <para> <para>One or more Availability Zones for the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.DefaultCooldown"> <summary> <para> <para>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html">Understanding Auto Scaling Cooldowns</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.DesiredCapacity"> <summary> <para> <para>The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.HealthCheckGracePeriod"> <summary> <para> <para>The amount of time, in seconds, that Auto Scaling waits before checking the health status of an instance. The grace period begins when the instance passes the system status and instance status checks from Amazon EC2. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.HealthCheckType"> <summary> <para> <para>The type of health check for the instances in the Auto Scaling group. The health check type can either be <code>EC2</code> for Amazon EC2 or <code>ELB</code> for Elastic Load Balancing. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.LaunchConfigurationName"> <summary> <para> <para>The name of the launch configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.MaxSize"> <summary> <para> <para>The maximum size of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.MinSize"> <summary> <para> <para>The minimum size of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.PlacementGroup"> <summary> <para> <para>The name of the placement group into which you'll launch your instances, if any. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.TerminationPolicy"> <summary> <para> <para> A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed. </para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-termination-policy.html">Choosing a Termination Policy for Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.VPCZoneIdentifier"> <summary> <para> <para>The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.</para><para>When you specify <code>VPCZoneIdentifier</code> with <code>AvailabilityZones</code>, ensure that the subnets' Availability Zones match the values you specify for <code>AvailabilityZones</code>. </para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html">Auto Scaling and Amazon Virtual Private Cloud</a> in the <i>Auto Scaling Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.UpdateASAutoScalingGroupCmdlet.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.AS.WriteASLifecycleActionHeartbeatCmdlet"> <summary> Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the <code>HeartbeatTimeout</code> parameter of <a>PutLifecycleHook</a>. <para> This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group: </para><ol><li>Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.</li><li>Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.</li><li>Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.</li><li><b>If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.</b></li><li>Complete the lifecycle action.</li></ol><para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingPendingState.html">Auto Scaling Pending State</a> and <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingTerminatingState.html">Auto Scaling Terminating State</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleActionHeartbeatCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group for the hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleActionHeartbeatCmdlet.LifecycleActionToken"> <summary> <para> <para>A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleActionHeartbeatCmdlet.LifecycleHookName"> <summary> <para> <para>The name of the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleActionHeartbeatCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleActionHeartbeatCmdlet.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.AS.WriteASLifecycleHookCmdlet"> <summary> Creates or updates a lifecycle hook for the specified Auto Scaling Group. <para> A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates. </para><para> This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group: </para><ol><li>Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.</li><li>Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.</li><li><b>Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.</b></li><li>If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.</li><li>Complete the lifecycle action.</li></ol><para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingPendingState.html">Auto Scaling Pending State</a> and <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingTerminatingState.html">Auto Scaling Terminating State</a> in the <i>Auto Scaling Developer Guide</i>. </para><para> If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group to which you want to assign the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.DefaultResult"> <summary> <para> <para>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>. The default value for this parameter is <code>ABANDON</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.HeartbeatTimeout"> <summary> <para> <para>The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the <code>DefaultResult</code> parameter. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>. The default is 3600 seconds (1 hour).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.LifecycleHookName"> <summary> <para> <para>The name of the lifecycle hook.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.LifecycleTransition"> <summary> <para> <para>The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>.</para><para>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.NotificationMetadata"> <summary> <para> <para>Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.NotificationTargetARN"> <summary> <para> <para>The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. </para><para>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</para><para>The notification message sent to the target will include:</para><ul><li><b>LifecycleActionToken</b>. The Lifecycle action token.</li><li><b>AccountId</b>. The user account ID.</li><li><b>AutoScalingGroupName</b>. The name of the Auto Scaling group.</li><li><b>LifecycleHookName</b>. The lifecycle hook name.</li><li><b>EC2InstanceId</b>. The EC2 instance ID.</li><li><b>LifecycleTransition</b>. The lifecycle transition.</li><li><b>NotificationMetadata</b>. The notification metadata.</li></ul><para>This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.</para><para>When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: <code>Event:autoscaling:TEST_NOTIFICATION</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.RoleARN"> <summary> <para> <para>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</para><para>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASLifecycleHookCmdlet.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.AS.WriteASNotificationConfigurationCmdlet"> <summary> Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address. <para> For more information see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html">Getting Notifications When Your Auto Scaling Group Changes</a> in the <i>Auto Scaling Developer Guide</i>. </para><para> This configuration overwrites an existing configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASNotificationConfigurationCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASNotificationConfigurationCmdlet.NotificationType"> <summary> <para> <para>The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see <a>DescribeAutoScalingNotificationTypes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASNotificationConfigurationCmdlet.TopicARN"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASNotificationConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASNotificationConfigurationCmdlet.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.AS.WriteASScalingPolicyCmdlet"> <summary> Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. <para> If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.AdjustmentType"> <summary> <para> <para>The adjustment type. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html">Dynamic Scaling</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name or ARN of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.Cooldown"> <summary> <para> <para>The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.</para><para>This parameter is not supported unless the policy type is <code>SimpleScaling</code>.</para><para>For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html">Understanding Auto Scaling Cooldowns</a> in the <i>Auto Scaling Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.EstimatedInstanceWarmup"> <summary> <para> <para>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.</para><para>This parameter is not supported if the policy type is <code>SimpleScaling</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.MetricAggregationType"> <summary> <para> <para>The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the aggregation type is null, the value is treated as <code>Average</code>.</para><para>This parameter is not supported if the policy type is <code>SimpleScaling</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.MinAdjustmentMagnitude"> <summary> <para> <para>The minimum number of instances to scale. If the value of <code>AdjustmentType</code> is <code>PercentChangeInCapacity</code>, the scaling policy changes the <code>DesiredCapacity</code> of the Auto Scaling group by at least this many instances. Otherwise, the error is <code>ValidationError</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.MinAdjustmentStep"> <summary> <para> <para>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code> instead.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.PolicyType"> <summary> <para> <para>The policy type. Valid values are <code>SimpleScaling</code> and <code>StepScaling</code>. If the policy type is null, the value is treated as <code>SimpleScaling</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.ScalingAdjustment"> <summary> <para> <para>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.</para><para>This parameter is required if the policy type is <code>SimpleScaling</code> and not supported otherwise.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.StepAdjustment"> <summary> <para> <para>A set of adjustments that enable you to scale based on the size of the alarm breach.</para><para>This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScalingPolicyCmdlet.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.AS.WriteASScheduledUpdateGroupActionCmdlet"> <summary> Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scheduled Scaling</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.AutoScalingGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.DesiredCapacity"> <summary> <para> <para> The number of EC2 instances that should be running in the group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.EndTime"> <summary> <para> <para>The time for this action to end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.MaxSize"> <summary> <para> <para> The maximum size for the Auto Scaling group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.MinSize"> <summary> <para> <para> The minimum size for the Auto Scaling group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.Recurrence"> <summary> <para> <para>The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For more information, see <a href="http://en.wikipedia.org/wiki/Cron">Cron</a> in Wikipedia.</para><para>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action will start and stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.ScheduledActionName"> <summary> <para> <para>The name of this scaling action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.StartTime"> <summary> <para> <para>The time for this action to start, in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only (for example, <code>2014-06-01T00:00:00Z</code>).</para><para>If you try to schedule your action in the past, Auto Scaling returns an error message. </para><para>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action starts and stops.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.Time"> <summary> <para> <para>This parameter is deprecated; use <code>StartTime</code> instead.</para><para>The time for this action to start. If both <code>Time</code> and <code>StartTime</code> are specified, their values must be identical.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.PassThru"> <summary> Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AS.WriteASScheduledUpdateGroupActionCmdlet.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.MCA.NewMCADataSetCmdlet"> <summary> Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:getBucketLocation, sns:SetRegion, sns:ListTopics, sns:Publish, iam:GetRolePolicy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MCA.NewMCADataSetCmdlet.DataSetPublicationDate"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MCA.NewMCADataSetCmdlet.DataSetType"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MCA.NewMCADataSetCmdlet.DestinationS3BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MCA.NewMCADataSetCmdlet.DestinationS3Prefix"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MCA.NewMCADataSetCmdlet.RoleNameArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MCA.NewMCADataSetCmdlet.SnsTopicArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.AddASAAttachmentsToSetCmdlet"> <summary> Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists. <para> An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASAAttachmentsToSetCmdlet.Attachment"> <summary> <para> <para>One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASAAttachmentsToSetCmdlet.AttachmentSetId"> <summary> <para> <para>The ID of the attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASAAttachmentsToSetCmdlet.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.ASA.AddASACommunicationToCaseCmdlet"> <summary> Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication. <para> The response indicates the success or failure of the request. </para><para> This operation implements a subset of the features of the AWS Support Center. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.AttachmentSetId"> <summary> <para> <para>The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling <a>AddAttachmentsToSet</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.CaseId"> <summary> <para> <para>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.CcEmailAddress"> <summary> <para> <para>The email addresses in the CC line of an email to be added to the support case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.CommunicationBody"> <summary> <para> <para>The body of an email communication to add to the support case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.AddASACommunicationToCaseCmdlet.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.ASA.GetASAAttachmentCmdlet"> <summary> Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASAAttachmentCmdlet.AttachmentId"> <summary> <para> <para>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet"> <summary> Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. You can set values for the <code>IncludeResolvedCases</code> and <code>IncludeCommunications</code> request parameters to control how much information is returned. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para><para> The response returns the following in JSON format: </para><ol><li>One or more <a>CaseDetails</a> data types. </li><li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.AfterTime"> <summary> <para> <para>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.BeforeTime"> <summary> <para> <para>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.CaseIdList"> <summary> <para> <para>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.DisplayId"> <summary> <para> <para>The ID displayed for a case in the AWS Support Center user interface. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.IncludeCommunication"> <summary> <para> <para>Specifies whether communications should be included in the <a>DescribeCases</a> results. The default is <i>true</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.IncludeResolvedCase"> <summary> <para> <para>Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results. The default is <i>false</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return before paginating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACasesCmdlet.NextToken"> <summary> <para> <para>A resumption point for pagination.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationsCmdlet"> <summary> Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para><para> You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationsCmdlet.AfterTime"> <summary> <para> <para>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationsCmdlet.BeforeTime"> <summary> <para> <para>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationsCmdlet.CaseId"> <summary> <para> <para>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationsCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return before paginating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASACommunicationsCmdlet.NextToken"> <summary> <para> <para>A resumption point for pagination.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASAServicesCmdlet"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASAServicesCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASAServicesCmdlet.ServiceCodeList"> <summary> <para> <para>A JSON-formatted list of service codes available for AWS services.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASASeverityLevelsCmdlet"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASASeverityLevelsCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckRefreshStatusesCmdlet"> <summary> Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckRefreshStatusesCmdlet.CheckId"> <summary> <para> <para>The IDs of the Trusted Advisor checks.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckResultCmdlet"> <summary> Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects: </para><ul><li><a>TrustedAdvisorCategorySpecificSummary</a></li><li><a>TrustedAdvisorResourceDetail</a></li><li><a>TrustedAdvisorResourcesSummary</a></li></ul><para> In addition, the response contains these fields: </para><ul><li><b>Status.</b> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".</li><li><b>Timestamp.</b> The time of the last refresh of the check.</li><li><b>CheckId.</b> The unique identifier for the check.</li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckResultCmdlet.CheckId"> <summary> <para> <para>The unique identifier for the Trusted Advisor check.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckResultCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorChecksCmdlet"> <summary> Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorChecksCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckSummariesCmdlet"> <summary> Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.GetASATrustedAdvisorCheckSummariesCmdlet.CheckId"> <summary> <para> <para>The IDs of the Trusted Advisor checks.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet"> <summary> Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. Its parameters require you to specify the following information: <ol><li><b>IssueType.</b> The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." </li><li><b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li><li><b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li><li><b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li><li><b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li><li><b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li><li><b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li><li><b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li><li><b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href="http://aws.amazon.com/tools/">AWS SDK</a>. </li></ol><note><para> To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>. </para></note><para> A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.AttachmentSetId"> <summary> <para> <para>The ID of a set of one or more attachments for the case. Create the set by using <a>AddAttachmentsToSet</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.CategoryCode"> <summary> <para> <para>The category of problem for the AWS Support case. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.CcEmailAddress"> <summary> <para> <para>A list of email addresses that AWS Support copies on case correspondence.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.CommunicationBody"> <summary> <para> <para>The communication body text when you create an AWS Support case by calling <a>CreateCase</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.IssueType"> <summary> <para> <para>The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.Language"> <summary> <para> <para>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.ServiceCode"> <summary> <para> <para>The code for the AWS service returned by the call to <a>DescribeServices</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.SeverityCode"> <summary> <para> <para>The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>.</para><note><para>The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.Subject"> <summary> <para> <para>The title of the AWS Support case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.NewASACaseCmdlet.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.ASA.RequestASATrustedAdvisorCheckRefreshCmdlet"> <summary> Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields: </para><ul><li><b>Status.</b> The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".</li><li><b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li><li><b>CheckId.</b> The unique identifier for the check.</li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.RequestASATrustedAdvisorCheckRefreshCmdlet.CheckId"> <summary> <para> <para>The unique identifier for the Trusted Advisor check.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.RequestASATrustedAdvisorCheckRefreshCmdlet.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.ASA.ResolveASACaseCmdlet"> <summary> Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.ResolveASACaseCmdlet.CaseId"> <summary> <para> <para>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ASA.ResolveASACaseCmdlet.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.CFN.GetCFNAccountLimitsCmdlet"> <summary> Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNAccountLimitsCmdlet.NextToken"> <summary> <para> <para>A string that identifies the next page of limits that you want to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackCmdlet"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackCmdlet.StackName"> <summary> <para> <para>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</para><ul><li>Running stacks: You can specify either the stack's name or its unique stack ID.</li><li>Deleted stacks: You must specify the unique stack ID.</li></ul><para>Default: There is no default value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackCmdlet.NextToken"> <summary> <para> String that identifies the start of the next list of stacks, if there is one. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackEventCmdlet"> <summary> Returns all stack related events for a specified stack. For more information about a stack's event history, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the AWS CloudFormation User Guide. <note>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackEventCmdlet.StackName"> <summary> <para> <para>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</para><ul><li>Running stacks: You can specify either the stack's name or its unique stack ID.</li><li>Deleted stacks: You must specify the unique stack ID.</li></ul><para>Default: There is no default value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackEventCmdlet.NextToken"> <summary> <para> <para>String that identifies the start of the next list of events, if there is one.</para><para>Default: There is no default value.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackPolicyCmdlet"> <summary> Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackPolicyCmdlet.StackName"> <summary> <para> <para>The name or unique stack ID that is associated with the stack whose policy you want to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourceCmdlet"> <summary> Returns a description of the specified resource in the specified stack. <para> For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourceCmdlet.LogicalResourceId"> <summary> <para> <para>The logical name of the resource as specified in the template.</para><para>Default: There is no default value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourceCmdlet.StackName"> <summary> <para> <para>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</para><ul><li>Running stacks: You can specify either the stack's name or its unique stack ID.</li><li>Deleted stacks: You must specify the unique stack ID.</li></ul><para>Default: There is no default value.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourcesCmdlet"> <summary> Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned. <note>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</note><para> For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted. </para><para> You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>. </para><note>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourcesCmdlet.LogicalResourceId"> <summary> <para> <para>The logical name of the resource as specified in the template.</para><para>Default: There is no default value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourcesCmdlet.PhysicalResourceId"> <summary> <para> <para>The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.</para><para>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</para><para>Required: Conditional. If you do not specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</para><para>Default: There is no default value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourcesCmdlet.StackName"> <summary> <para> <para>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</para><ul><li>Running stacks: You can specify either the stack's name or its unique stack ID.</li><li>Deleted stacks: You must specify the unique stack ID.</li></ul><para>Default: There is no default value.</para><para>Required: Conditional. If you do not specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourceSummaryCmdlet"> <summary> Returns descriptions of all resources of the specified stack. <para> For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourceSummaryCmdlet.StackName"> <summary> <para> <para>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</para><ul><li>Running stacks: You can specify either the stack's name or its unique stack ID.</li><li>Deleted stacks: You must specify the unique stack ID.</li></ul><para>Default: There is no default value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackResourceSummaryCmdlet.NextToken"> <summary> <para> <para>String that identifies the start of the next list of stack resource summaries, if there is one.</para><para>Default: There is no default value.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackSummaryCmdlet"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackSummaryCmdlet.StackStatusFilter"> <summary> <para> <para>Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the <code>StackStatus</code> parameter of the <a>Stack</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNStackSummaryCmdlet.NextToken"> <summary> <para> <para>String that identifies the start of the next list of stacks, if there is one.</para><para>Default: There is no default value.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNTemplateCmdlet"> <summary> Returns the template body for a specified stack. You can get the template for running or deleted stacks. <para> For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. </para><note> If the template does not exist, a <code>ValidationError</code> is returned. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNTemplateCmdlet.StackName"> <summary> <para> <para>The name or the unique stack ID that is associated with the stack, which are not always interchangeable:</para><ul><li>Running stacks: You can specify either the stack's name or its unique stack ID.</li><li>Deleted stacks: You must specify the unique stack ID.</li></ul><para>Default: There is no default value.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.GetCFNTemplateSummaryCmdlet"> <summary> Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack. <para> You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack. </para><para> For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNTemplateSummaryCmdlet.StackName"> <summary> <para> <para>The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.</para><para>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNTemplateSummaryCmdlet.TemplateBody"> <summary> <para> <para>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.</para><para>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.GetCFNTemplateSummaryCmdlet.TemplateURL"> <summary> <para> <para>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.</para><para>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.MeasureCFNTemplateCostCmdlet"> <summary> Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.MeasureCFNTemplateCostCmdlet.Parameter"> <summary> <para> <para>A list of <code>Parameter</code> structures that specify input parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.MeasureCFNTemplateCostCmdlet.TemplateBody"> <summary> <para> <para>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.)</para><para>Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.MeasureCFNTemplateCostCmdlet.TemplateURL"> <summary> <para> <para>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.</para><para>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.MeasureCFNTemplateCostCmdlet.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.CFN.NewCFNStackCmdlet"> <summary> Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.Capability"> <summary> <para> <para>A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</para><para>Currently, the only valid value is <code>CAPABILITY_IAM</code>, which is required for the following resources: <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html"> AWS::IAM::AccessKey</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html"> AWS::IAM::Group</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html"> AWS::IAM::InstanceProfile</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html"> AWS::IAM::Policy</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html"> AWS::IAM::Role</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html"> AWS::IAM::User</a>, and <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.DisableRollback"> <summary> <para> <para>Set to <code>true</code> to disable rollback of the stack if stack creation failed. You can specify either <code>DisableRollback</code> or <code>OnFailure</code>, but not both.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.NotificationARNs"> <summary> <para> <para>The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the <a href="http://console.aws.amazon.com/sns">SNS console</a> or your Command Line Interface (CLI).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.OnFailure"> <summary> <para> <para>Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either <code>OnFailure</code> or <code>DisableRollback</code>, but not both.</para><para>Default: <code>ROLLBACK</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.Parameter"> <summary> <para> <para>A list of <code>Parameter</code> structures that specify input parameters for the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.ResourceType"> <summary> <para> <para>The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all AWS resource), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i></code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular AWS service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i></code> (for a specific AWS resource).</para><para>If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with AWS Identity and Access Management</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.StackName"> <summary> <para> <para>The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.</para><note>A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 255 characters.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.StackPolicyBody"> <summary> <para> <para>Structure containing the stack policy body. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.StackPolicyURL"> <summary> <para> <para>Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.Tag"> <summary> <para> <para>A set of user-defined <code>Tags</code> to associate with this stack, represented by key/value pairs. Tags defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.TemplateBody"> <summary> <para> <para>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.</para><para>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.TemplateURL"> <summary> <para> <para>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.</para><para>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.TimeoutInMinutes"> <summary> <para> <para>The amount of time that can pass before the stack status becomes CREATE_FAILED; if <code>DisableRollback</code> is not set or is set to <code>false</code>, the stack will be rolled back.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.NewCFNStackCmdlet.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.CFN.RemoveCFNStackCmdlet"> <summary> Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.RemoveCFNStackCmdlet.StackName"> <summary> <para> <para>The name or the unique stack ID that is associated with the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.RemoveCFNStackCmdlet.PassThru"> <summary> Returns the value passed to the StackName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.RemoveCFNStackCmdlet.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.CFN.SendCFNResourceSignalCmdlet"> <summary> Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SendCFNResourceSignalCmdlet.LogicalResourceId"> <summary> <para> <para>The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SendCFNResourceSignalCmdlet.StackName"> <summary> <para> <para>The stack name or unique stack ID that includes the resource that you want to signal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SendCFNResourceSignalCmdlet.Status"> <summary> <para> <para>The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SendCFNResourceSignalCmdlet.UniqueId"> <summary> <para> <para>A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SendCFNResourceSignalCmdlet.PassThru"> <summary> Returns the value passed to the StackName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SendCFNResourceSignalCmdlet.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.CFN.SetCFNStackPolicyCmdlet"> <summary> Sets a stack policy for a specified stack. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SetCFNStackPolicyCmdlet.StackName"> <summary> <para> <para>The name or unique stack ID that you want to associate a policy with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SetCFNStackPolicyCmdlet.StackPolicyBody"> <summary> <para> <para>Structure containing the stack policy body. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SetCFNStackPolicyCmdlet.StackPolicyURL"> <summary> <para> <para>Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SetCFNStackPolicyCmdlet.PassThru"> <summary> Returns the value passed to the StackName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.SetCFNStackPolicyCmdlet.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.CFN.StopCFNUpdateStackCmdlet"> <summary> Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.StopCFNUpdateStackCmdlet.StackName"> <summary> <para> <para>The name or the unique stack ID that is associated with the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.StopCFNUpdateStackCmdlet.PassThru"> <summary> Returns the value passed to the StackName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.StopCFNUpdateStackCmdlet.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.CFN.TestCFNTemplateCmdlet"> <summary> Validates a specified template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.TestCFNTemplateCmdlet.TemplateBody"> <summary> <para> <para>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.</para><para>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.TestCFNTemplateCmdlet.TemplateURL"> <summary> <para> <para>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.</para><para>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet"> <summary> Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action. <para> To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action. </para><para> Tags that were associated with this stack during creation time will still be associated with the stack after an <code>UpdateStack</code> operation. </para><para> For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a Stack</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.Capability"> <summary> <para> <para>A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. Currently, the only valid value is <code>CAPABILITY_IAM</code>, which is required for the following resources: <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html"> AWS::IAM::AccessKey</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html"> AWS::IAM::Group</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html"> AWS::IAM::InstanceProfile</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html"> AWS::IAM::Policy</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html"> AWS::IAM::Role</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html"> AWS::IAM::User</a>, and <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an InsufficientCapabilities error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.NotificationARNs"> <summary> <para> <para>Update the ARNs for the Amazon SNS topics that are associated with the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.Parameter"> <summary> <para> <para>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.ResourceType"> <summary> <para> <para>The template resource types that you have permissions to work with for this update stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</para><para>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with AWS Identity and Access Management</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.StackName"> <summary> <para> <para>The name or unique stack ID of the stack to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.StackPolicyBody"> <summary> <para> <para>Structure containing a new stack policy body. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</para><para>You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.StackPolicyDuringUpdateBody"> <summary> <para> <para>Structure containing the temporary overriding stack policy body. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</para><para>If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.StackPolicyDuringUpdateURL"> <summary> <para> <para>Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</para><para>If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.StackPolicyURL"> <summary> <para> <para>Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</para><para>You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.TemplateBody"> <summary> <para> <para>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.)</para><para>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.TemplateURL"> <summary> <para> <para>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.</para><para>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.UsePreviousTemplate"> <summary> <para> <para>Reuse the existing template that is associated with the stack that you are updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFN.UpdateCFNStackCmdlet.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.CF.NewCFSignedCookieCmdlet"> <summary> Creates signed cookies that grants universal access to private content until a given date (using a canned policy) or tailored access to private content based on an access time window and ip range. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.ResourceUri"> <summary> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <i>"http://" + distributionName + "/" + path</i> (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with <i>"https://"</i>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.KeyPairId"> <summary> The key pair id corresponding to the private key file given. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.PrivateKeyFile"> <summary> The private key file. RSA private key (.pem) are supported. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.ExpiresOn"> <summary> The expiration date till which content can be accessed using the generated cookies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.ActiveFrom"> <summary> The date from which content can be accessed using the generated cookies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedCookieCmdlet.IpRange"> <summary> The allowed IP address range of the client making the GET request, in CIDR form (e.g. 192.168.0.1/24). If not specified, a CIDR of 0.0.0.0/0 (i.e. no IP restriction) is used. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet"> <summary> Creates a signed URL that grants universal access to private content until a given date (using a canned policy) or tailored access to private content based on an access time window and ip range. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.ResourceUri"> <summary> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <i>"http://" + distributionName + "/" + path</i> (may also include URL parameters). For distributions with the HTTPS required protocol, the resource URL must start with <i>"https://"</i>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.KeyPairId"> <summary> The key pair id corresponding to the private key file supplied to the PrivateKeyFile parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.PrivateKeyFile"> <summary> The private key file. RSA private key (.pem) files are supported. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.ExpiresOn"> <summary> The expiration date of the signed URL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.ActiveFrom"> <summary> The date from which the URL can be accessed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.IpRange"> <summary> The allowed IP address range of the client making the GET request, in CIDR form (e.g. 192.168.0.1/24). If not specified, a CIDR of 0.0.0.0/0 (i.e. no IP restriction) is used. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFSignedUrlCmdlet.AsString"> <summary> If set the cmdlet outputs the signed url as a simple string. The default is to wrap and emit the url as a System.Uri object. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentitiesCmdlet"> <summary> List origin access identities. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentitiesCmdlet.Marker"> <summary> <para> Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentitiesCmdlet.MaxItem"> <summary> <para> The maximum number of origin access identities you want in the response body. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityCmdlet"> <summary> Get the information about an origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityCmdlet.Id"> <summary> <para> The identity's id. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityConfigCmdlet"> <summary> Get the configuration information about an origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFCloudFrontOriginAccessIdentityConfigCmdlet.Id"> <summary> <para> The identity's id. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionCmdlet"> <summary> Get the information about a distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionCmdlet.Id"> <summary> <para> The distribution's id. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionConfigCmdlet"> <summary> Get the configuration information about a distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionConfigCmdlet.Id"> <summary> <para> The distribution's id. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet"> <summary> List the distributions that are associated with a specified AWS WAF web ACL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.WebACLId"> <summary> <para> The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify "null" for the Id, the request returns a list of the distributions that aren't associated with a web ACL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.Marker"> <summary> <para> Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.) </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionListByWebACLIdCmdlet.MaxItem"> <summary> <para> The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsCmdlet"> <summary> List distributions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsCmdlet.Marker"> <summary> <para> Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.) </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFDistributionsCmdlet.MaxItem"> <summary> <para> The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationCmdlet"> <summary> Get the information about an invalidation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationCmdlet.DistributionId"> <summary> <para> The distribution's id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationCmdlet.Id"> <summary> <para> The invalidation's id. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationsCmdlet"> <summary> List invalidation batches. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationsCmdlet.DistributionId"> <summary> <para> The distribution's id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationsCmdlet.Marker"> <summary> <para> Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFInvalidationsCmdlet.MaxItem"> <summary> <para> The maximum number of invalidation batches you want in the response body. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionCmdlet"> <summary> Get the information about a streaming distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionCmdlet.Id"> <summary> <para> The streaming distribution's id. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionConfigCmdlet"> <summary> Get the configuration information about a streaming distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionConfigCmdlet.Id"> <summary> <para> The streaming distribution's id. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionsCmdlet"> <summary> List streaming distributions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionsCmdlet.Marker"> <summary> <para> Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.GetCFStreamingDistributionsCmdlet.MaxItem"> <summary> <para> The maximum number of streaming distributions you want in the response body. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet"> <summary> Create a new origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_CallerReference"> <summary> <para> A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_Comment"> <summary> <para> Any comments you want to include about the origin access identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFCloudFrontOriginAccessIdentityCmdlet.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.CF.NewCFDistributionCmdlet"> <summary> Create a new distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Logging_Bucket"> <summary> <para> The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_CallerReference"> <summary> <para> A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_CloudFrontDefaultCertificate"> <summary> <para> If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_Comment"> <summary> <para> Any comments you want to include about the distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_DefaultRootObject"> <summary> <para> The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_DefaultTTL"> <summary> <para> If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_Enabled"> <summary> <para> Whether the distribution is enabled to accept end user requests for content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Logging_Enabled"> <summary> <para> Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Cookies_Forward"> <summary> <para> Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_IAMCertificateId"> <summary> <para> If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Logging_IncludeCookie"> <summary> <para> Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Aliases_Item"> <summary> <para> Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CacheBehaviors_Item"> <summary> <para> Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CustomErrorResponses_Item"> <summary> <para> Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CachedMethods_Item"> <summary> <para> A complex type that contains the HTTP methods that you want CloudFront to cache responses to. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.AllowedMethods_Item"> <summary> <para> A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.WhitelistedNames_Item"> <summary> <para> Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Headers_Item"> <summary> <para> Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Item"> <summary> <para> Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Origins_Item"> <summary> <para> A complex type that contains origins for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.GeoRestriction_Item"> <summary> <para> A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_MaxTTL"> <summary> <para> The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_MinimumProtocolVersion"> <summary> <para> Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_MinTTL"> <summary> <para> The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Logging_Prefix"> <summary> <para> An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_PriceClass"> <summary> <para> A complex type that contains information about price class for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Aliases_Quantity"> <summary> <para> The number of CNAMEs, if any, for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CacheBehaviors_Quantity"> <summary> <para> The number of cache behaviors for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CustomErrorResponses_Quantity"> <summary> <para> The number of custom error responses for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.CachedMethods_Quantity"> <summary> <para> The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.AllowedMethods_Quantity"> <summary> <para> The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.WhitelistedNames_Quantity"> <summary> <para> The number of whitelisted cookies for this cache behavior. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Headers_Quantity"> <summary> <para> The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> The number of trusted signers for this cache behavior. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.Origins_Quantity"> <summary> <para> The number of origins for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.GeoRestriction_Quantity"> <summary> <para> When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ForwardedValues_QueryString"> <summary> <para> Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.GeoRestriction_RestrictionType"> <summary> <para> The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_SmoothStreaming"> <summary> <para> Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.ViewerCertificate_SSLSupportMethod"> <summary> <para> If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_TargetOriginId"> <summary> <para> The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DefaultCacheBehavior_ViewerProtocolPolicy"> <summary> <para> Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.DistributionConfig_WebACLId"> <summary> <para> (Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFDistributionCmdlet.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.CF.NewCFInvalidationCmdlet"> <summary> Create a new invalidation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.InvalidationBatch_CallerReference"> <summary> <para> A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.DistributionId"> <summary> <para> The distribution's id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.Paths_Item"> <summary> <para> A complex type that contains a list of the objects that you want to invalidate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.Paths_Quantity"> <summary> <para> The number of objects that you want to invalidate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFInvalidationCmdlet.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.CF.NewCFStreamingDistributionCmdlet"> <summary> Create a new streaming distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Logging_Bucket"> <summary> <para> The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.StreamingDistributionConfig_CallerReference"> <summary> <para> A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.StreamingDistributionConfig_Comment"> <summary> <para> Any comments you want to include about the streaming distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.S3Origin_DomainName"> <summary> <para> The DNS name of the S3 origin. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.StreamingDistributionConfig_Enabled"> <summary> <para> Whether the streaming distribution is enabled to accept end user requests for content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Logging_Enabled"> <summary> <para> Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Aliases_Item"> <summary> <para> Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.TrustedSigners_Item"> <summary> <para> Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.S3Origin_OriginAccessIdentity"> <summary> <para> Your S3 origin's origin access identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Logging_Prefix"> <summary> <para> An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.StreamingDistributionConfig_PriceClass"> <summary> <para> A complex type that contains information about price class for this streaming distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.Aliases_Quantity"> <summary> <para> The number of CNAMEs, if any, for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> The number of trusted signers for this cache behavior. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.NewCFStreamingDistributionCmdlet.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.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet"> <summary> Delete an origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.Id"> <summary> <para> The origin access identity's id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.IfMatch"> <summary> <para> The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFCloudFrontOriginAccessIdentityCmdlet.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.CF.RemoveCFDistributionCmdlet"> <summary> Delete a distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.Id"> <summary> <para> The distribution id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.IfMatch"> <summary> <para> The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFDistributionCmdlet.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.CF.RemoveCFStreamingDistributionCmdlet"> <summary> Delete a streaming distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.Id"> <summary> <para> The distribution id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.IfMatch"> <summary> <para> The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.RemoveCFStreamingDistributionCmdlet.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.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet"> <summary> Update an origin access identity. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_CallerReference"> <summary> <para> A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.CloudFrontOriginAccessIdentityConfig_Comment"> <summary> <para> Any comments you want to include about the origin access identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.Id"> <summary> <para> The identity's id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.IfMatch"> <summary> <para> The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFCloudFrontOriginAccessIdentityCmdlet.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.CF.UpdateCFDistributionCmdlet"> <summary> Update a distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Logging_Bucket"> <summary> <para> The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_CallerReference"> <summary> <para> A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_CloudFrontDefaultCertificate"> <summary> <para> If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_Comment"> <summary> <para> Any comments you want to include about the distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_DefaultRootObject"> <summary> <para> The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_DefaultTTL"> <summary> <para> If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_Enabled"> <summary> <para> Whether the distribution is enabled to accept end user requests for content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Logging_Enabled"> <summary> <para> Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Cookies_Forward"> <summary> <para> Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_IAMCertificateId"> <summary> <para> If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Id"> <summary> <para> The distribution's id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.IfMatch"> <summary> <para> The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Logging_IncludeCookie"> <summary> <para> Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Aliases_Item"> <summary> <para> Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CacheBehaviors_Item"> <summary> <para> Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CustomErrorResponses_Item"> <summary> <para> Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CachedMethods_Item"> <summary> <para> A complex type that contains the HTTP methods that you want CloudFront to cache responses to. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.AllowedMethods_Item"> <summary> <para> A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.WhitelistedNames_Item"> <summary> <para> Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Headers_Item"> <summary> <para> Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Item"> <summary> <para> Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Origins_Item"> <summary> <para> A complex type that contains origins for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.GeoRestriction_Item"> <summary> <para> A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_MaxTTL"> <summary> <para> The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_MinimumProtocolVersion"> <summary> <para> Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_MinTTL"> <summary> <para> The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Logging_Prefix"> <summary> <para> An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_PriceClass"> <summary> <para> A complex type that contains information about price class for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Aliases_Quantity"> <summary> <para> The number of CNAMEs, if any, for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CacheBehaviors_Quantity"> <summary> <para> The number of cache behaviors for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CustomErrorResponses_Quantity"> <summary> <para> The number of custom error responses for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.CachedMethods_Quantity"> <summary> <para> The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.AllowedMethods_Quantity"> <summary> <para> The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.WhitelistedNames_Quantity"> <summary> <para> The number of whitelisted cookies for this cache behavior. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Headers_Quantity"> <summary> <para> The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> The number of trusted signers for this cache behavior. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.Origins_Quantity"> <summary> <para> The number of origins for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.GeoRestriction_Quantity"> <summary> <para> When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ForwardedValues_QueryString"> <summary> <para> Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.GeoRestriction_RestrictionType"> <summary> <para> The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_SmoothStreaming"> <summary> <para> Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.ViewerCertificate_SSLSupportMethod"> <summary> <para> If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_TargetOriginId"> <summary> <para> The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DefaultCacheBehavior_ViewerProtocolPolicy"> <summary> <para> Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.DistributionConfig_WebACLId"> <summary> <para> (Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFDistributionCmdlet.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.CF.UpdateCFStreamingDistributionCmdlet"> <summary> Update a streaming distribution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Logging_Bucket"> <summary> <para> The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.StreamingDistributionConfig_CallerReference"> <summary> <para> A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.StreamingDistributionConfig_Comment"> <summary> <para> Any comments you want to include about the streaming distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.S3Origin_DomainName"> <summary> <para> The DNS name of the S3 origin. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.StreamingDistributionConfig_Enabled"> <summary> <para> Whether the streaming distribution is enabled to accept end user requests for content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Logging_Enabled"> <summary> <para> Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.TrustedSigners_Enabled"> <summary> <para> Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Id"> <summary> <para> The streaming distribution's id. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.IfMatch"> <summary> <para> The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Aliases_Item"> <summary> <para> Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.TrustedSigners_Item"> <summary> <para> Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.S3Origin_OriginAccessIdentity"> <summary> <para> Your S3 origin's origin access identity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Logging_Prefix"> <summary> <para> An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.StreamingDistributionConfig_PriceClass"> <summary> <para> A complex type that contains information about price class for this streaming distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.Aliases_Quantity"> <summary> <para> The number of CNAMEs, if any, for this distribution. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.TrustedSigners_Quantity"> <summary> <para> The number of trusted signers for this cache behavior. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CF.UpdateCFStreamingDistributionCmdlet.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.HSM.EditHSMItemCmdlet"> <summary> Modifies an HSM. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMItemCmdlet.EniIp"> <summary> <para> <para>The new IP address for the elastic network interface attached to the HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMItemCmdlet.ExternalId"> <summary> <para> <para>The new external ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMItemCmdlet.HsmArn"> <summary> <para> <para>The ARN of the HSM to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMItemCmdlet.IamRoleArn"> <summary> <para> <para>The new IAM role ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMItemCmdlet.SubnetId"> <summary> <para> <para>The new identifier of the subnet that the HSM is in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMItemCmdlet.SyslogIp"> <summary> <para> <para>The new IP address for the syslog monitoring server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMItemCmdlet.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.HSM.EditHSMLunaClientCmdlet"> <summary> Modifies the certificate used by the client. <para> This action can potentially start a workflow to install the new certificate on the client's HSMs. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMLunaClientCmdlet.Certificate"> <summary> <para> <para>The new certificate for the client. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMLunaClientCmdlet.ClientArn"> <summary> <para> <para>The ARN of the client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMLunaClientCmdlet.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.HSM.EditHSMPartitionGroupCmdlet"> <summary> Modifies an existing high-availability partition group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMPartitionGroupCmdlet.HapgArn"> <summary> <para> <para>The ARN of the high-availability partition group to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMPartitionGroupCmdlet.Label"> <summary> <para> <para>The new label for the high-availability partition group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMPartitionGroupCmdlet.PartitionSerialList"> <summary> <para> <para>The list of partition serial numbers to make members of the high-availability partition group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.EditHSMPartitionGroupCmdlet.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.HSM.GetHSMAvailableZonesCmdlet"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM.GetHSMConfigCmdlet"> <summary> Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMConfigCmdlet.ClientArn"> <summary> <para> <para>The ARN of the client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMConfigCmdlet.ClientVersion"> <summary> <para> <para>The client version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMConfigCmdlet.HapgList"> <summary> <para> <para>A list of ARNs that identify the high-availability partition groups that are associated with the client.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM.GetHSMItemCmdlet"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMItemCmdlet.HsmArn"> <summary> <para> <para>The ARN of the HSM. Either the <i>HsmArn</i> or the <i>SerialNumber</i> parameter must be specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMItemCmdlet.HsmSerialNumber"> <summary> <para> <para>The serial number of the HSM. Either the <i>HsmArn</i> or the <i>HsmSerialNumber</i> parameter must be specified.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM.GetHSMItemListCmdlet"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMItemListCmdlet.NextToken"> <summary> <para> <para>The <i>NextToken</i> value from a previous call to <a>ListHsms</a>. Pass null if this is the first call.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM.GetHSMLunaClientCmdlet"> <summary> Retrieves information about an HSM client. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMLunaClientCmdlet.CertificateFingerprint"> <summary> <para> <para>The certificate fingerprint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMLunaClientCmdlet.ClientArn"> <summary> <para> <para>The ARN of the client.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM.GetHSMLunaClientListCmdlet"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMLunaClientListCmdlet.NextToken"> <summary> <para> <para>The <i>NextToken</i> value from a previous call to <a>ListLunaClients</a>. Pass null if this is the first call.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM.GetHSMPartitionGroupCmdlet"> <summary> Retrieves information about a high-availability partition group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMPartitionGroupCmdlet.HapgArn"> <summary> <para> <para>The ARN of the high-availability partition group to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM.GetHSMPartitionGroupListCmdlet"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.GetHSMPartitionGroupListCmdlet.NextToken"> <summary> <para> <para>The <i>NextToken</i> value from a previous call to <a>ListHapgs</a>. Pass null if this is the first call.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet"> <summary> Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.ClientToken"> <summary> <para> <para>A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.EniIp"> <summary> <para> <para>The IP address to assign to the HSM's ENI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.ExternalId"> <summary> <para> <para>The external ID from <b>IamRoleArn</b>, if present.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.IamRoleArn"> <summary> <para> <para>The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.SshKey"> <summary> <para> <para>The SSH public key to install on the HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.SubnetId"> <summary> <para> <para>The identifier of the subnet in your VPC in which to place the HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.SubscriptionType"> <summary> <para> <para>The subscription type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.SyslogIp"> <summary> <para> <para>The IP address for the syslog monitoring server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMItemCmdlet.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.HSM.NewHSMLunaClientCmdlet"> <summary> Creates an HSM client. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMLunaClientCmdlet.Certificate"> <summary> <para> <para>The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMLunaClientCmdlet.Label"> <summary> <para> <para>The label for the client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMLunaClientCmdlet.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.HSM.NewHSMPartitionGroupCmdlet"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMPartitionGroupCmdlet.Label"> <summary> <para> <para>The label of the new high-availability partition group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.NewHSMPartitionGroupCmdlet.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.HSM.RemoveHSMItemCmdlet"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.RemoveHSMItemCmdlet.HsmArn"> <summary> <para> <para>The ARN of the HSM to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.RemoveHSMItemCmdlet.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.HSM.RemoveHSMLunaClientCmdlet"> <summary> Deletes a client. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.RemoveHSMLunaClientCmdlet.ClientArn"> <summary> <para> <para>The ARN of the client to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.RemoveHSMLunaClientCmdlet.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.HSM.RemoveHSMPartitionGroupCmdlet"> <summary> Deletes a high-availability partition group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.RemoveHSMPartitionGroupCmdlet.HapgArn"> <summary> <para> <para>The ARN of the high-availability partition group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM.RemoveHSMPartitionGroupCmdlet.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.CSD.GetCSDSuggestionsCmdlet"> <summary> Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. <para> For more information about configuring suggesters and retrieving suggestions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para><para> The endpoint for submitting <code>Suggest</code> requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.GetCSDSuggestionsCmdlet.ServiceUrl"> <summary> <para> Gets and sets the property ServiceUrl. <para> Specifies the Search or Document service endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.GetCSDSuggestionsCmdlet.Query"> <summary> <para> Gets and sets the property Query. <para> Specifies the string for which you want to get suggestions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.GetCSDSuggestionsCmdlet.Size"> <summary> <para> Gets and sets the property Size. <para> Specifies the maximum number of suggestions to return. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.GetCSDSuggestionsCmdlet.Suggester"> <summary> <para> Gets and sets the property Suggester. <para> Specifies the name of the suggester to use to find suggested matches. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.GetCSDSuggestionsCmdlet.UseAnonymousCredentials"> <summary> If set, the cmdlet calls the service operation using anonymous credentials. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet"> <summary> Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: <ul><li><code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. </li><li><code>structured</code>: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.</li><li><code>lucene</code>: specify search criteria using the Apache Lucene query parser syntax.</li><li><code>dismax</code>: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.</li></ul><para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para><para> The endpoint for submitting <code>Search</code> requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.ServiceUrl"> <summary> <para> Gets and sets the property ServiceUrl. <para> Specifies the Search or Document service endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Cursor"> <summary> <para> Gets and sets the property Cursor. <para> Retrieves a cursor value you can use to page through large result sets. Use the <code>size</code> parameter to control the number of hits to include in each response. You can specify either the <code>cursor</code> or <code>start</code> parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to <code>initial</code>. In subsequent requests, specify the cursor value returned in the hits section of the response. </para><para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Expr"> <summary> <para> Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields. </para> <para> You specify the expressions in JSON using the form <code>{"EXPRESSIONNAME":"EXPRESSION"}</code>. You can define and use multiple expressions in a search request. For example: </para> <para> <code> {"expression1":"_score*rating", "expression2":"(1/rank)*year"} </code> </para> <para> For information about the variables, operators, and functions you can use in expressions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions">Writing Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Facet"> <summary> <para> Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}</code>. </para> <para> You can specify the following faceting options: </para> <ul> <li> <para> <code>buckets</code> specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html"> Searching for a Range of Values</a> in the <i>Amazon CloudSearch Developer Guide</i>. Buckets are returned in the order they are specified in the request. The <code>sort</code> and <code>size</code> options are not valid if you specify <code>buckets</code>. </para> </li> <li> <para> <code>size</code> specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The <code>size</code> parameter is only valid when you specify the <code>sort</code> option; it cannot be used in conjunction with <code>buckets</code>. </para> </li> <li> <para> <code>sort</code> specifies how you want to sort the facets in the results: <code>bucket</code> or <code>count</code>. Specify <code>bucket</code> to sort alphabetically or numerically by facet value (in ascending order). Specify <code>count</code> to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the <code>buckets</code> option instead of <code>sort</code>. </para> </li> </ul> <para> If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results. </para> <para> To count particular buckets of values, use the <code>buckets</code> option. For example, the following request uses the <code>buckets</code> option to calculate and return facet counts by decade. </para> <para> <code> {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} </code> </para> <para> To sort facets by facet count, use the <code>count</code> option. For example, the following request sets the <code>sort</code> option to <code>count</code> to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the <code>size</code> option to 3 returns only the top three facet values. </para> <para> <code> {"year":{"sort":"count","size":3}} </code> </para> <para> To sort the facets by value, use the <code>bucket</code> option. For example, the following request sets the <code>sort</code> option to <code>bucket</code> to sort the facet values numerically by year, with earliest year listed first. </para> <para> <code> {"year":{"sort":"bucket"}} </code> </para> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html">Getting and Using Facet Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.FilterQuery"> <summary> <para> Gets and sets the property FilterQuery. <para> Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use <code>filterQuery</code> in conjunction with the <code>query</code> parameter to filter the documents that match the constraints specified in the <code>query</code> parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The <code>filterQuery</code> parameter supports the full structured query syntax. </para><para> For more information about using filters, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html">Filtering Matching Documents</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Highlight"> <summary> <para> Retrieves highlights for matches in the specified <code>text</code> or <code>text-array</code> fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}</code>. </para> <para> You can specify the following highlight options: </para> <ul> <li> <code>format</code>: specifies the format of the data in the text field: <code>text</code> or <code>html</code>. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is <code>html</code>. </li> <li> <code>max_phrases</code>: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted. </li> <li> <code>pre_tag</code>: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is <code>&lt;em&gt;</code>. The default for text highlights is <code>*</code>. </li> <li> <code>post_tag</code>: specifies the string to append to an occurrence of a search term. The default for HTML highlights is <code>&lt;/em&gt;</code>. The default for text highlights is <code>*</code>. </li> </ul> <para> If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: <code>&lt;em>search-term&lt;/em&gt;</code>. </para> <para> For example, the following request retrieves highlights for the <code>actors</code> and <code>title</code> fields. </para> <para> <code>{ "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "<b>","post_tag": "</b>"} }</code> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Partial"> <summary> <para> Gets and sets the property Partial. <para> Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Query"> <summary> <para> Gets and sets the property Query. <para> Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the <code>queryOptions</code> parameter. By default, the <code>simple</code> query parser is used to process requests. To use the <code>structured</code>, <code>lucene</code>, or <code>dismax</code> query parser, you must also specify the <code>queryParser</code> parameter. </para><para> For more information about specifying search criteria, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.QueryOption"> <summary> <para> Configures options for the query parser specified in the <code>queryParser</code> parameter. You specify the options in JSON using the following form <code>{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.</code> </para> <para> The options you can configure vary according to which parser you use: </para> <ul> <li> <code>defaultOperator</code>: The default operator used to combine individual terms in the search string. For example: <code>defaultOperator: 'or'</code>. For the <code>dismax</code> parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of <code>0%</code> is the equivalent to OR, and a value of <code>100%</code> is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, <code>defaultOperator: 50%</code>. Valid values: <code>and</code>, <code>or</code>, a percentage in the range 0%-100% (<code>dismax</code>). Default: <code>and</code> (<code>simple</code>, <code>structured</code>, <code>lucene</code>) or <code>100</code> (<code>dismax</code>). Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>.</li> <li> <code>fields</code>: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost the importance of the <code>title</code> field over the <code>description</code> field you could specify: <code>"fields":["title^5","description"]</code>. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All <code>text</code> and <code>text-array</code> fields. Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>.</li> <li> <code>operators</code>: An array of the operators or special characters you want to disable for the simple query parser. If you disable the <code>and</code>, <code>or</code>, or <code>not</code> operators, the corresponding operators (<code>+</code>, <code>|</code>, <code>-</code>) have no special meaning and are dropped from the search string. Similarly, disabling <code>prefix</code> disables the wildcard operator (<code>*</code>) and disabling <code>phrase</code> disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling <code>near</code> disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the <code>fuzzy</code> operator disables the ability to use the ~ operator to perform a fuzzy search. <code>escape</code> disables the ability to use a backslash (<code>\</code>) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: <code>"operators":["and","not","or", "prefix"]</code>. Valid values: <code>and</code>, <code>escape</code>, <code>fuzzy</code>, <code>near</code>, <code>not</code>, <code>or</code>, <code>phrase</code>, <code>precedence</code>, <code>prefix</code>, <code>whitespace</code>. Default: All operators and special characters are enabled. Valid for: <code>simple</code>.</li> <li> <code>phraseFields</code>: An array of the <code>text</code> or <code>text-array</code> fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The <code>phraseSlop</code> option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost phrase matches in the <code>title</code> field over the <code>abstract</code> field, you could specify: <code>"phraseFields":["title^3", "plot"]</code> Valid values: The name of any <code>text</code> or <code>text-array</code> field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with <code>phraseFields</code>, proximity scoring is disabled even if <code>phraseSlop</code> is specified. Valid for: <code>dismax</code>.</li> <li> <code>phraseSlop</code>: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the <code>phraseFields</code> option; for example, <code>phraseSlop: 2</code>. You must also specify <code>phraseFields</code> to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>.</li> <li> <code>explicitPhraseSlop</code>: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify <code>"explicitPhraseSlop":3</code>. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>.</li> <li> <code>tieBreaker</code>: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a <code>tieBreaker</code> value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is <code>(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)</code>. Set <code>tieBreaker</code> to 0 to disregard all but the highest scoring field (pure max): <code>"tieBreaker":0</code>. Set to 1 to sum the scores from all fields (pure sum): <code>"tieBreaker":1</code>. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: <code>dismax</code>. </li> </ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.QueryParser"> <summary> <para> Gets and sets the property QueryParser. <para> Specifies which query parser to use to process the request. If <code>queryParser</code> is not specified, Amazon CloudSearch uses the <code>simple</code> query parser. </para><para> Amazon CloudSearch supports four query parsers: </para><ul><li><code>simple</code>: perform simple searches of <code>text</code> and <code>text-array</code> fields. By default, the <code>simple</code> query parser searches all <code>text</code> and <code>text-array</code> fields. You can specify which fields to search by with the <code>queryOptions</code> parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the <code>queryOptions</code> parameter.) You can use the <code>-</code> (NOT), <code>|</code> (OR), and <code>*</code> (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html">Searching for Text</a> in the <i>Amazon CloudSearch Developer Guide</i>. </li><li><code>structured</code>: perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, <code>matchall</code>, and <code>near</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html">Constructing Compound Queries</a> in the <i>Amazon CloudSearch Developer Guide</i>. </li><li><code>lucene</code>: search using the Apache Lucene query parser syntax. For more information, see <a href="http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">Apache Lucene Query Parser Syntax</a>. </li><li><code>dismax</code>: search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see <a href="http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax">DisMax Query Parser Syntax</a>. </li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Return"> <summary> <para> Gets and sets the property Return. <para> Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (<code>_all_fields</code>). To return only the document IDs for the matching documents, specify <code>_no_fields</code>. To retrieve the relevance score calculated for each document, specify <code>_score</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Size"> <summary> <para> Gets and sets the property Size. <para> Specifies the maximum number of search hits to include in the response. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Sort"> <summary> <para> Gets and sets the property Sort. <para> Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (<code>asc</code> or <code>desc</code>) for each field; for example, <code>year desc,title asc</code>. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no <code>sort</code> parameter is specified, results are sorted by their default relevance scores in descending order: <code>_score desc</code>. You can also sort by document ID (<code>_id asc</code>) and version (<code>_version desc</code>). </para><para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html">Sorting Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.Start"> <summary> <para> Gets and sets the property Start. <para> Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the <code>start</code> or <code>cursor</code> parameter in a request, they are mutually exclusive. </para><para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentsCmdlet.UseAnonymousCredentials"> <summary> If set, the cmdlet calls the service operation using anonymous credentials. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CSD.WriteCSDDocumentsCmdlet"> <summary> Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. <para> The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para><para> For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.WriteCSDDocumentsCmdlet.ServiceUrl"> <summary> <para> Gets and sets the property ServiceUrl. <para> Specifies the Search or Document service endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.WriteCSDDocumentsCmdlet.ContentType"> <summary> <para> Gets and sets the property ContentType. <para> The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: </para><ul><li>application/json</li><li>application/xml</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.WriteCSDDocumentsCmdlet.Document"> <summary> <para> Gets and sets the property Documents. <para> A batch of documents formatted in JSON or HTML. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.WriteCSDDocumentsCmdlet.FilePath"> <summary> <para> <para> The full path and name to a file that contains a batch of documents to be uploaded. The batch of documents should be formatted in JSON or HTML. If this property is set, the UploadDocumentsRequest.Documents property is ignored. </para><para> For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.WriteCSDDocumentsCmdlet.UseAnonymousCredentials"> <summary> If set, the cmdlet calls the service operation using anonymous credentials. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CSD.WriteCSDDocumentsCmdlet.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.CS.GetCSAnalysisSchemeCmdlet"> <summary> Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAnalysisSchemeCmdlet.AnalysisSchemeName"> <summary> <para> <para>The analysis schemes you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAnalysisSchemeCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAnalysisSchemeCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSAvailabilityOptionCmdlet"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAvailabilityOptionCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAvailabilityOptionCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSDomainCmdlet"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSDomainCmdlet.DomainName"> <summary> <para> <para>The names of the domains you want to include in the response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSDomainNameCmdlet"> <summary> Lists all search domains owned by an account. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSExpressionCmdlet"> <summary> Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSExpressionCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSExpressionCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSExpressionCmdlet.ExpressionName"> <summary> <para> <para>Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSIndexFieldCmdlet"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSIndexFieldCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSIndexFieldCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSIndexFieldCmdlet.FieldName"> <summary> <para> <para>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSScalingParameterCmdlet"> <summary> Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSScalingParameterCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSServiceAccessPolicyCmdlet"> <summary> Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSServiceAccessPolicyCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSServiceAccessPolicyCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSSuggesterCmdlet"> <summary> Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSSuggesterCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSSuggesterCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSSuggesterCmdlet.SuggesterName"> <summary> <para> <para>The suggesters you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.NewCSDomainCmdlet"> <summary> Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.NewCSDomainCmdlet.DomainName"> <summary> <para> <para>A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.NewCSDomainCmdlet.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.CS.RemoveCSAnalysisSchemeCmdlet"> <summary> Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSAnalysisSchemeCmdlet.AnalysisSchemeName"> <summary> <para> <para>The name of the analysis scheme you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSAnalysisSchemeCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSAnalysisSchemeCmdlet.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.CS.RemoveCSDomainCmdlet"> <summary> Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSDomainCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to permanently delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSDomainCmdlet.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.CS.RemoveCSExpressionCmdlet"> <summary> Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSExpressionCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSExpressionCmdlet.ExpressionName"> <summary> <para> <para>The name of the <code><a>Expression</a></code> to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSExpressionCmdlet.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.CS.RemoveCSIndexFieldCmdlet"> <summary> Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSIndexFieldCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSIndexFieldCmdlet.IndexFieldName"> <summary> <para> <para>The name of the index field your want to remove from the domain's indexing options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSIndexFieldCmdlet.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.CS.RemoveCSSuggesterCmdlet"> <summary> Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSSuggesterCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSSuggesterCmdlet.SuggesterName"> <summary> <para> <para>Specifies the name of the suggester you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSSuggesterCmdlet.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.CS.SetCSAnalysisSchemeCmdlet"> <summary> Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_AlgorithmicStemming"> <summary> <para> <para>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings" target="_blank">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisScheme_AnalysisSchemeLanguage"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisScheme_AnalysisSchemeName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_JapaneseTokenizationDictionary"> <summary> <para> <para>A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_StemmingDictionary"> <summary> <para> <para>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{"term1": "stem1", "term2": "stem2", "term3": "stem3"}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_Stopword"> <summary> <para> <para>A JSON array of terms to ignore during indexing and searching. For example, <code>["a", "an", "the", "of"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_Synonym"> <summary> <para> <para>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.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.CS.SetCSExpressionCmdlet"> <summary> Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet.Expression_ExpressionName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet.Expression_ExpressionValue"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet.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.CS.SetCSIndexFieldCmdlet"> <summary> Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_AnalysisScheme"> <summary> <para> <para>The name of an analysis scheme for a <code>text-array</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_AnalysisScheme"> <summary> <para> <para>The name of an analysis scheme for a <code>text</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_DefaultValue"> <summary> <para> <para>A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_HighlightEnabled"> <summary> <para> <para>Whether highlights can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_HighlightEnabled"> <summary> <para> <para>Whether highlights can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IndexField_IndexFieldName"> <summary> <para> <para>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. </para><para>Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. </para><para>The name <code>score</code> is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <code>_id</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IndexField_IndexFieldType"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_SourceField"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_SourceField"> <summary> <para> <para>The name of the source field to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_SourceField"> <summary> <para> <para>The name of the source field to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_SourceField"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_SourceField"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_SourceField"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.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.CS.SetCSSuggesterCmdlet"> <summary> Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.DocumentSuggesterOptions_FuzzyMatching"> <summary> <para> <para>The level of fuzziness allowed when suggesting matches for a string: <code>none</code>, <code>low</code>, or <code>high</code>. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.DocumentSuggesterOptions_SortExpression"> <summary> <para> <para>An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the <code>_score</code> value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.DocumentSuggesterOptions_SourceField"> <summary> <para> <para>The name of the index field you want to use for suggestions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.Suggester_SuggesterName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.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.CS.StartCSIndexCmdlet"> <summary> Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.StartCSIndexCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.StartCSIndexCmdlet.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.CS.StartCSSuggestersBuildCmdlet"> <summary> Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.StartCSSuggestersBuildCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.StartCSSuggestersBuildCmdlet.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.CS.UpdateCSAvailabilityOptionCmdlet"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSAvailabilityOptionCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSAvailabilityOptionCmdlet.MultiAZ"> <summary> <para> <para>You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to <code>false</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSAvailabilityOptionCmdlet.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.CS.UpdateCSScalingParameterCmdlet"> <summary> Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.ScalingParameters_DesiredInstanceType"> <summary> <para> <para>The instance type that you want to preconfigure for your domain. For example, <code>search.m1.small</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.ScalingParameters_DesiredPartitionCount"> <summary> <para> <para>The number of partitions you want to preconfigure for your domain. Only valid when you select <code>m2.2xlarge</code> as the desired instance type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.ScalingParameters_DesiredReplicationCount"> <summary> <para> <para>The number of replicas you want to preconfigure for each index partition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.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.CS.UpdateCSServiceAccessPolicyCmdlet"> <summary> Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank"> Configuring Access for an Amazon CloudSearch Domain</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSServiceAccessPolicyCmdlet.AccessPolicy"> <summary> <para> <para>The access rules you want to configure. These rules replace any existing rules. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSServiceAccessPolicyCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSServiceAccessPolicyCmdlet.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.CT.AddCTTagCmdlet"> <summary> Adds one or more tags to a trail, up to a limit of 10. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTTagCmdlet.ResourceId"> <summary> <para> <para>Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTTagCmdlet.TagsList"> <summary> <para> <para>Contains a list of CloudTrail tags, up to a limit of 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTTagCmdlet.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.CT.FindCTEventsCmdlet"> <summary> Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. <important>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. </important><important>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventsCmdlet.EndTime"> <summary> <para> <para>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventsCmdlet.LookupAttribute"> <summary> <para> <para>Contains a list of lookup attributes. Currently the list can contain only one item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventsCmdlet.StartTime"> <summary> <para> <para>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventsCmdlet.MaxResult"> <summary> <para> <para>The number of events to return. Possible values are 1 through 50. The default is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventsCmdlet.NextToken"> <summary> <para> <para>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet"> <summary> Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. <note>CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.EndTime"> <summary> <para> <para>Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.StartTime"> <summary> <para> <para>Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.NextToken"> <summary> <para> <para>Reserved for future use.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTagCmdlet"> <summary> Lists the tags for the trail in the current region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTagCmdlet.ResourceIdList"> <summary> <para> <para>Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTagCmdlet.NextToken"> <summary> <para> <para>Reserved for future use.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet.TrailNameList"> <summary> <para> <para>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. If an empty list is specified, information for the trail in the current region is returned.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTrailStatusCmdlet"> <summary> Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailStatusCmdlet.Name"> <summary> <para> <para>Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet"> <summary> Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.CloudWatchLogsLogGroupArn"> <summary> <para> <para>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.CloudWatchLogsRoleArn"> <summary> <para> <para>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.EnableLogFileValidation"> <summary> <para> <para>Specifies whether log file integrity validation is enabled. The default is false.</para><note>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.IncludeGlobalServiceEvent"> <summary> <para> <para>Specifies whether the trail is publishing events from global services such as IAM to the log files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.KmsKeyId"> <summary> <para> <para>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</para><para>Examples:</para><ul><li>alias/MyAliasName</li><li>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li><li>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>12345678-1234-1234-1234-123456789012</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.Name"> <summary> <para> <para>Specifies the name of the trail. The name must meet the following requirements:</para><ul><li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li><li>Start with a letter or number, and end with a letter or number</li><li>Be between 3 and 128 characters</li><li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li><li>Not be in IP address format (for example, 192.168.5.4)</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.S3BucketName"> <summary> <para> <para>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.S3KeyPrefix"> <summary> <para> <para>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.SnsTopicName"> <summary> <para> <para>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.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.CT.RemoveCTTagCmdlet"> <summary> Removes the specified tags from a trail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTagCmdlet.ResourceId"> <summary> <para> <para>Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTagCmdlet.TagsList"> <summary> <para> <para>Specifies a list of tags to be removed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTagCmdlet.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.CT.RemoveCTTrailCmdlet"> <summary> Deletes a trail. This operation must be called from the region in which the trail was created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.Name"> <summary> <para> <para>Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.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.CT.StartCTLoggingCmdlet"> <summary> Starts the recording of AWS API calls and log file delivery for a trail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.Name"> <summary> <para> <para>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.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.CT.StopCTLoggingCmdlet"> <summary> Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.Name"> <summary> <para> <para>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.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.CT.UpdateCTTrailCmdlet"> <summary> Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.CloudWatchLogsLogGroupArn"> <summary> <para> <para>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.CloudWatchLogsRoleArn"> <summary> <para> <para>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.EnableLogFileValidation"> <summary> <para> <para>Specifies whether log file validation is enabled. The default is false.</para><note>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.IncludeGlobalServiceEvent"> <summary> <para> <para>Specifies whether the trail is publishing events from global services such as IAM to the log files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.KmsKeyId"> <summary> <para> <para>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</para><para>Examples:</para><ul><li>alias/MyAliasName</li><li>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li><li>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>12345678-1234-1234-1234-123456789012</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.Name"> <summary> <para> <para>Specifies the name of the trail or trail ARN. If <code>Name</code> is a trail name, the string must meet the following requirements:</para><ul><li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li><li>Start with a letter or number, and end with a letter or number</li><li>Be between 3 and 128 characters</li><li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li><li>Not be in IP address format (for example, 192.168.5.4)</li></ul><para>If <code>Name</code> is a trail ARN, it must be in the format <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.S3BucketName"> <summary> <para> <para>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.S3KeyPrefix"> <summary> <para> <para>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.SnsTopicName"> <summary> <para> <para>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.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.CWL.GetCWLDestinationCmdlet"> <summary> Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name. <para> By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of destinations returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDestinationCmdlet.DestinationNamePrefix"> <summary> <para> <para>Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDestinationCmdlet.Limit"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLDestinationCmdlet.NextToken"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTasksCmdlet"> <summary> Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on <code>TaskId</code> or <code>TaskStatus</code>. <para> By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of export tasks returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTasksCmdlet.StatusCode"> <summary> <para> <para>All export tasks that matches the specified status code will be returned. This can return zero or more export tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTasksCmdlet.TaskId"> <summary> <para> <para>Export task that matches the specified task Id will be returned. This can result in zero or one export task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTasksCmdlet.Limit"> <summary> <para> <para> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLExportTasksCmdlet.NextToken"> <summary> <para> <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class="code">DescribeExportTasks</code> request. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet"> <summary> Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. You can limit the streams searched to an explicit list of <code class="code">logStreamNames</code>. <para> By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a <code class="code">nextToken</code>, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of <code class="code">searchedLogStreams</code> that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The <code class="code">limit</code> parameter in the request. can be used to specify the maximum number of events to return in a page. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.EndTime"> <summary> <para> <para>A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.FilterPattern"> <summary> <para> <para> A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.Interleaved"> <summary> <para> <para>If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.LogGroupName"> <summary> <para> <para> The name of the log group to query. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.LogStreamName"> <summary> <para> <para> Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.StartTime"> <summary> <para> <para>A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.Limit"> <summary> <para> <para>The maximum number of events to return in a page of results. Default is 10,000 events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLFilteredLogEventCmdlet.NextToken"> <summary> <para> <para>A pagination token obtained from a <code class="code">FilterLogEvents</code> response to continue paginating the FilterLogEvents results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventsCmdlet"> <summary> Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. <para> By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a <code class="code">nextForwardToken</code> and a <code class="code">nextBackwardToken</code> in the response body. You can use any of these tokens in subsequent <code class="code">GetLogEvents</code> requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventsCmdlet.EndTime"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventsCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventsCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventsCmdlet.StartFromHead"> <summary> <para> <para>If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventsCmdlet.StartTime"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventsCmdlet.Limit"> <summary> <para> <para> The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogEventsCmdlet.NextToken"> <summary> <para> <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the <code class="code">nextForwardToken</code> or <code class="code">nextBackwardToken</code> fields in the response of the previous <code class="code">GetLogEvents</code> request. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsCmdlet"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsCmdlet.LogGroupNamePrefix"> <summary> <para> <para>Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsCmdlet.Limit"> <summary> <para> <para> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogGroupsCmdlet.NextToken"> <summary> <para> <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class="code">DescribeLogGroups</code> request. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamsCmdlet"> <summary> Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name. <para> By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log streams returned in the response by specifying the <code class="code">limit</code> parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamsCmdlet.Descending"> <summary> <para> <para> If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamsCmdlet.LogGroupName"> <summary> <para> <para>The log group name for which log streams are to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamsCmdlet.LogStreamNamePrefix"> <summary> <para> <para> Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamsCmdlet.OrderBy"> <summary> <para> <para> Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamsCmdlet.Limit"> <summary> <para> <para> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLLogStreamsCmdlet.NextToken"> <summary> <para> <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class="code">DescribeLogStreams</code> request. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFiltersCmdlet"> <summary> Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of metric filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFiltersCmdlet.FilterNamePrefix"> <summary> <para> <para>Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFiltersCmdlet.LogGroupName"> <summary> <para> <para>The log group name for which metric filters are to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFiltersCmdlet.Limit"> <summary> <para> <para> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLMetricFiltersCmdlet.NextToken"> <summary> <para> <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class="code">DescribeMetricFilters</code> request. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFiltersCmdlet"> <summary> Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of subscription filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFiltersCmdlet.FilterNamePrefix"> <summary> <para> <para>Will only return subscription filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFiltersCmdlet.LogGroupName"> <summary> <para> <para>The log group name for which subscription filters are to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFiltersCmdlet.Limit"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.GetCWLSubscriptionFiltersCmdlet.NextToken"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet"> <summary> Creates an <code>ExportTask</code> which allows you to efficiently export data from a Log Group to your Amazon S3 bucket. <para> This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, <code>DescribeExportTasks</code> can be used to get the status of an export task. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.Destination"> <summary> <para> <para>Name of Amazon S3 bucket to which the log data will be exported. <b>NOTE: Only buckets in the same AWS region are supported</b></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.DestinationPrefix"> <summary> <para> <para>Prefix that will be used as the start of Amazon S3 key for every object exported. If not specified, this defaults to 'exportedlogs'.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.From"> <summary> <para> <para>A unix timestamp indicating the start time of the range for the request. Events with a timestamp prior to this time will not be exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.LogStreamNamePrefix"> <summary> <para> <para>Will only export log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.TaskName"> <summary> <para> <para>The name of the export task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.To"> <summary> <para> <para>A unix timestamp indicating the end time of the range for the request. Events with a timestamp later than this time will not be exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLExportTaskCmdlet.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.CWL.NewCWLLogGroupCmdlet"> <summary> Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account. <para> You must use the following guidelines when naming a log group: <ul><li>Log group names can be between 1 and 512 characters long.</li><li>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</li></ul></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.PassThru"> <summary> Returns the value passed to the LogGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogGroupCmdlet.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.CWL.NewCWLLogStreamCmdlet"> <summary> Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group. <para> You must use the following guidelines when naming a log stream: <ul><li>Log stream names can be between 1 and 512 characters long.</li><li>The ':' colon character is not allowed.</li></ul></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group under which the log stream is to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.PassThru"> <summary> Returns the value passed to the LogGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.NewCWLLogStreamCmdlet.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.CWL.RemoveCWLDestinationCmdlet"> <summary> Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDestinationCmdlet.DestinationName"> <summary> <para> <para>The name of destination to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDestinationCmdlet.PassThru"> <summary> Returns the value passed to the DestinationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLDestinationCmdlet.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.CWL.RemoveCWLLogGroupCmdlet"> <summary> Deletes the log group with the specified name and permanently deletes all the archived log events associated with it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupCmdlet.PassThru"> <summary> Returns the value passed to the LogGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogGroupCmdlet.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.CWL.RemoveCWLLogStreamCmdlet"> <summary> Deletes a log stream and permanently deletes all the archived log events associated with it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group under which the log stream to delete belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.PassThru"> <summary> Returns the value passed to the LogStreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLLogStreamCmdlet.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.CWL.RemoveCWLMetricFilterCmdlet"> <summary> Deletes a metric filter associated with the specified log group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.FilterName"> <summary> <para> <para>The name of the metric filter to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group that is associated with the metric filter to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.PassThru"> <summary> Returns the value passed to the FilterName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLMetricFilterCmdlet.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.CWL.RemoveCWLRetentionPolicyCmdlet"> <summary> Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLRetentionPolicyCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group that is associated with the retention policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLRetentionPolicyCmdlet.PassThru"> <summary> Returns the value passed to the LogGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLRetentionPolicyCmdlet.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.CWL.RemoveCWLSubscriptionFilterCmdlet"> <summary> Deletes a subscription filter associated with the specified log group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.FilterName"> <summary> <para> <para>The name of the subscription filter to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group that is associated with the subscription filter to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.PassThru"> <summary> Returns the value passed to the FilterName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.RemoveCWLSubscriptionFilterCmdlet.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.CWL.StopCWLExportTaskCmdlet"> <summary> Cancels an export task if it is in <code>PENDING</code> or <code>RUNNING</code> state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLExportTaskCmdlet.TaskId"> <summary> <para> <para>Id of the export task to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLExportTaskCmdlet.PassThru"> <summary> Returns the value passed to the TaskId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.StopCWLExportTaskCmdlet.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.CWL.TestCWLMetricFilterCmdlet"> <summary> Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.TestCWLMetricFilterCmdlet.FilterPattern"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.TestCWLMetricFilterCmdlet.LogEventMessage"> <summary> <para> <para>A list of log event messages to test.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet"> <summary> Creates or updates a <code>Destination</code>. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through <code class="code">PutLogEvents</code> requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination. <para> A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call <code>PutSubscriptionFilter</code> against this destination. To enable that, the destination owner must call <code>PutDestinationPolicy</code> after PutDestination. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.DestinationName"> <summary> <para> <para>A name for the destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.RoleArn"> <summary> <para> <para>The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.TargetArn"> <summary> <para> <para>The ARN of an Amazon Kinesis stream to deliver matching log events to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationCmdlet.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.CWL.WriteCWLDestinationPolicyCmdlet"> <summary> Creates or updates an access policy associated with an existing <code>Destination</code>. An access policy is an <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.AccessPolicy"> <summary> <para> <para>An IAM policy document that authorizes cross-account users to deliver their log events to associated destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.DestinationName"> <summary> <para> <para>A name for an existing destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.PassThru"> <summary> Returns the value passed to the DestinationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLDestinationPolicyCmdlet.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.CWL.WriteCWLLogEventsCmdlet"> <summary> Uploads a batch of log events to the specified log stream. <para> Every PutLogEvents request must include the <code class="code">sequenceToken</code> obtained from the response of the previous request. An upload in a newly created log stream does not require a <code class="code">sequenceToken</code>. </para><para> The batch of events must satisfy the following constraints: <ul><li>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</li><li>None of the log events in the batch can be more than 2 hours in the future.</li><li>None of the log events in the batch can be older than 14 days or the retention period of the log group.</li><li>The log events in the batch must be in chronological ordered by their <code class="code">timestamp</code>.</li><li>The maximum number of log events in a batch is 10,000.</li></ul></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventsCmdlet.LogEvent"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventsCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to put log events to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventsCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream to put log events to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventsCmdlet.SequenceToken"> <summary> <para> <para> A string token that must be obtained from the response of the previous <code class="code">PutLogEvents</code> request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLLogEventsCmdlet.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.CWL.WriteCWLMetricFilterCmdlet"> <summary> Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through <code class="code">PutLogEvents</code> requests. <para> The maximum number of metric filters that can be associated with a log group is 100. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.FilterName"> <summary> <para> <para>A name for the metric filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.FilterPattern"> <summary> <para> <para>A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to associate the metric filter with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.MetricTransformation"> <summary> <para> <para>A collection of information needed to define how metric data gets emitted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.PassThru"> <summary> Returns the value passed to the LogGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLMetricFilterCmdlet.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.CWL.WriteCWLRetentionPolicyCmdlet"> <summary> Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLRetentionPolicyCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to associate the retention policy with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLRetentionPolicyCmdlet.RetentionInDays"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLRetentionPolicyCmdlet.PassThru"> <summary> Returns the value passed to the LogGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLRetentionPolicyCmdlet.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.CWL.WriteCWLSubscriptionFilterCmdlet"> <summary> Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <code class="code">PutLogEvents</code> requests and have them delivered to a specific destination. Currently, the supported destinations are: <ul><li> A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. </li><li> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery. </li></ul><para> Currently there can only be one subscription filter associated with a log group. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.DestinationArn"> <summary> <para> <para>The ARN of the destination to deliver matching log events to. Currently, the supported destinations are: <ul><li> A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. </li><li> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery. </li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.FilterName"> <summary> <para> <para>A name for the subscription filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.FilterPattern"> <summary> <para> <para>A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.LogGroupName"> <summary> <para> <para>The name of the log group to associate the subscription filter with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.RoleArn"> <summary> <para> <para>The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination (used via an ARN of <code>Destination</code>) for cross-account delivery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.PassThru"> <summary> Returns the value passed to the LogGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CWL.WriteCWLSubscriptionFilterCmdlet.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.CW.GetCWMetricsCmdlet"> <summary> <para> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. </para><para><b>NOTE:</b> Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. </para><para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricsCmdlet.Namespace"> <summary> <para> The namespace to filter against. <para><b>Constraints:</b><list type="definition"><item><term>Length</term><description>1 - 255</description></item><item><term>Pattern</term><description>[^:].*</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricsCmdlet.MetricName"> <summary> <para> The name of the metric to filter against. <para><b>Constraints:</b><list type="definition"><item><term>Length</term><description>1 - 255</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricsCmdlet.Dimension"> <summary> <para> A list of dimensions to filter against. <para><b>Constraints:</b><list type="definition"><item><term>Length</term><description>0 - 10</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricsCmdlet.NextToken"> <summary> <para> The token returned by a previous call to indicate that there is more data available. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricsCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all metrics to the pipeline. If set, the cmdlet will retrieve only the next 'page' of results (max 500 entries) using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CW.DisableCWAlarmActionCmdlet"> <summary> Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.DisableCWAlarmActionCmdlet.AlarmName"> <summary> <para> <para> The names of the alarms to disable actions for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.DisableCWAlarmActionCmdlet.PassThru"> <summary> Returns the value passed to the AlarmName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.DisableCWAlarmActionCmdlet.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.CW.EnableCWAlarmActionCmdlet"> <summary> Enables actions for the specified alarms. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.EnableCWAlarmActionCmdlet.AlarmName"> <summary> <para> <para> The names of the alarms to enable actions for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.EnableCWAlarmActionCmdlet.PassThru"> <summary> Returns the value passed to the AlarmName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.EnableCWAlarmActionCmdlet.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.CW.GetCWAlarmCmdlet"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmCmdlet.ActionPrefix"> <summary> <para> <para> The action name prefix. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmCmdlet.AlarmNamePrefix"> <summary> <para> <para> The alarm name prefix. <code>AlarmNames</code> cannot be specified if this parameter is specified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmCmdlet.AlarmName"> <summary> <para> <para> A list of alarm names to retrieve information for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmCmdlet.StateValue"> <summary> <para> <para> The state value to be used in matching alarms. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of alarm descriptions to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmCmdlet.NextToken"> <summary> <para> <para> The token returned by a previous call to indicate that there is more data available. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmForMetricCmdlet"> <summary> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmForMetricCmdlet.Dimension"> <summary> <para> <para> The list of dimensions associated with the metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmForMetricCmdlet.MetricName"> <summary> <para> <para> The name of the metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmForMetricCmdlet.Namespace"> <summary> <para> <para> The namespace of the metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmForMetricCmdlet.Period"> <summary> <para> <para> The period in seconds over which the statistic is applied. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmForMetricCmdlet.Statistic"> <summary> <para> <para> The statistic for the metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmForMetricCmdlet.Unit"> <summary> <para> <para> The unit for the metric. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmHistoryCmdlet"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmHistoryCmdlet.AlarmName"> <summary> <para> <para> The name of the alarm. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmHistoryCmdlet.EndDate"> <summary> <para> <para> The ending date to retrieve alarm history. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmHistoryCmdlet.HistoryItemType"> <summary> <para> <para> The type of alarm histories to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmHistoryCmdlet.StartDate"> <summary> <para> <para> The starting date to retrieve alarm history. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmHistoryCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of alarm history records to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWAlarmHistoryCmdlet.NextToken"> <summary> <para> <para> The token returned by a previous call to indicate that there is more data available. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet"> <summary> Gets statistics for the specified metric. <para> The maximum number of data points returned from a single <code>GetMetricStatistics</code> request is 1,440, wereas the maximum number of data points that can be queried is 50,850. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. </para><para> Amazon CloudWatch aggregates data points based on the length of the <code>period</code> that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned. </para><para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <code>GetMetricStatistics</code> on Amazon EC2 instances with detailed (one-minute) monitoring enabled: </para><ul><li>Statistics for up to 400 instances for a span of one hour</li><li>Statistics for up to 35 instances over a span of 24 hours</li><li>Statistics for up to 2 instances over a span of 2 weeks</li></ul><para> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html">Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference</a> in the <i>Amazon CloudWatch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet.Dimension"> <summary> <para> <para> A list of dimensions describing qualities of the metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet.EndTime"> <summary> <para> <para> The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet.MetricName"> <summary> <para> <para> The name of the metric, with or without spaces. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet.Namespace"> <summary> <para> <para> The namespace of the metric, with or without spaces. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet.Period"> <summary> <para> <para> The granularity, in seconds, of the returned datapoints. <code>Period</code> must be at least 60 seconds and must be a multiple of 60. The default value is 60. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet.StartTime"> <summary> <para> <para> The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet.Statistic"> <summary> <para> <para> The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, go to <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/index.html?CHAP_TerminologyandKeyConcepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch Developer Guide</i>. </para><para> Valid Values: <code>Average | Sum | SampleCount | Maximum | Minimum</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.GetCWMetricStatisticsCmdlet.Unit"> <summary> <para> <para> The unit for the metric. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CW.RemoveCWAlarmCmdlet"> <summary> Deletes all specified alarms. In the event of an error, no alarms are deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.RemoveCWAlarmCmdlet.AlarmName"> <summary> <para> <para> A list of alarms to be deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.RemoveCWAlarmCmdlet.PassThru"> <summary> Returns the value passed to the AlarmName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.RemoveCWAlarmCmdlet.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.CW.SetCWAlarmStateCmdlet"> <summary> Temporarily sets the state of an alarm. When the updated <code>StateValue</code> differs from the previous value, the action configured for the appropriate state is invoked. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.SetCWAlarmStateCmdlet.AlarmName"> <summary> <para> <para> The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.SetCWAlarmStateCmdlet.StateReason"> <summary> <para> <para> The reason that this alarm is set to this specific state (in human-readable text format) </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.SetCWAlarmStateCmdlet.StateReasonData"> <summary> <para> <para> The reason that this alarm is set to this specific state (in machine-readable JSON format) </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.SetCWAlarmStateCmdlet.StateValue"> <summary> <para> <para> The value of the state. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.SetCWAlarmStateCmdlet.PassThru"> <summary> Returns the value passed to the AlarmName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.SetCWAlarmStateCmdlet.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.CW.WriteCWMetricAlarmCmdlet"> <summary> Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm. <para> When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its <code>StateValue</code> is set appropriately. Any actions associated with the <code>StateValue</code> is then executed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.ActionsEnabled"> <summary> <para> <para> Indicates whether or not actions should be executed during any changes to the alarm's state. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.AlarmAction"> <summary> <para> <para> The list of actions to execute when this alarm transitions into an <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.AlarmDescription"> <summary> <para> <para> The description for the alarm. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.AlarmName"> <summary> <para> <para> The descriptive name for the alarm. This name must be unique within the user's AWS account </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.ComparisonOperator"> <summary> <para> <para> The arithmetic operation to use when comparing the specified <code>Statistic</code> and <code>Threshold</code>. The specified <code>Statistic</code> value is used as the first operand. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.Dimension"> <summary> <para> <para> The dimensions for the alarm's associated metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.EvaluationPeriod"> <summary> <para> <para> The number of periods over which data is compared to the specified threshold. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.InsufficientDataAction"> <summary> <para> <para> The list of actions to execute when this alarm transitions into an <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.MetricName"> <summary> <para> <para> The name for the alarm's associated metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.Namespace"> <summary> <para> <para> The namespace for the alarm's associated metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.OKAction"> <summary> <para> <para> The list of actions to execute when this alarm transitions into an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.Period"> <summary> <para> <para> The period in seconds over which the specified statistic is applied. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.Statistic"> <summary> <para> <para> The statistic to apply to the alarm's associated metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.Threshold"> <summary> <para> <para> The value against which the specified statistic is compared. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.Unit"> <summary> <para> <para> The unit for the alarm's associated metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.PassThru"> <summary> Returns the value passed to the AlarmName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricAlarmCmdlet.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.CW.WriteCWMetricDataCmdlet"> <summary> Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. It can take up to fifteen minutes for a new metric to appear in calls to the <a>ListMetrics</a> action. <para> The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests. </para><important> Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. </important><para> Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricDataCmdlet.MetricData"> <summary> <para> <para> A list of data describing the metric. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricDataCmdlet.Namespace"> <summary> <para> <para> The namespace for the metric data. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricDataCmdlet.PassThru"> <summary> Returns the value passed to the Namespace parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CW.WriteCWMetricDataCmdlet.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.CC.GetCCBranchCmdlet"> <summary> Retrieves information about a repository branch, including its name and the last commit ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCBranchCmdlet.BranchName"> <summary> <para> <para>The name of the branch for which you want to retrieve information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCBranchCmdlet.RepositoryName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CC.GetCCBranchListCmdlet"> <summary> Gets information about one or more branches in a repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCBranchListCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository that contains the branches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCBranchListCmdlet.NextToken"> <summary> <para> <para>An enumeration token that allows the operation to batch the results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CC.GetCCRepositoryCmdlet"> <summary> Gets information about a repository. <note><para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCRepositoryCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to get information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CC.GetCCRepositoryBatchCmdlet"> <summary> Gets information about one or more repositories. <note><para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCRepositoryBatchCmdlet.RepositoryName"> <summary> <para> <para>The names of the repositories to get information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CC.GetCCRepositoryListCmdlet"> <summary> Gets information about one or more repositories. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCRepositoryListCmdlet.Order"> <summary> <para> <para>The order in which to sort the results of a list repositories operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCRepositoryListCmdlet.SortBy"> <summary> <para> <para>The criteria used to sort the results of a list repositories operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.GetCCRepositoryListCmdlet.NextToken"> <summary> <para> <para>An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CC.NewCCBranchCmdlet"> <summary> Creates a new branch in a repository and points the branch to a commit. <note>Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.NewCCBranchCmdlet.BranchName"> <summary> <para> <para>The name of the new branch to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.NewCCBranchCmdlet.CommitId"> <summary> <para> <para>The ID of the commit to point the new branch to.</para><note>If this commit ID is not specified, the new branch will point to the commit that is pointed to by the repository's default branch.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.NewCCBranchCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository in which you want to create the new branch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.NewCCBranchCmdlet.PassThru"> <summary> Returns the value passed to the RepositoryName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.NewCCBranchCmdlet.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.CC.NewCCRepositoryCmdlet"> <summary> Creates a new, empty repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.NewCCRepositoryCmdlet.RepositoryDescription"> <summary> <para> <para>A comment or description about the new repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.NewCCRepositoryCmdlet.RepositoryName"> <summary> <para> <para>The name of the new repository to be created.</para><note>The repository name must be unique across the calling AWS account. In addition, repository names are restricted to alphanumeric characters. The suffix ".git" is prohibited.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.NewCCRepositoryCmdlet.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.CC.RemoveCCRepositoryCmdlet"> <summary> Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned. <important>Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.</important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.RemoveCCRepositoryCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.RemoveCCRepositoryCmdlet.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.CC.UpdateCCDefaultBranchCmdlet"> <summary> Sets or changes the default branch name for the specified repository. <note>If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCDefaultBranchCmdlet.DefaultBranchName"> <summary> <para> <para>The name of the branch to set as the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCDefaultBranchCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to set or change the default branch for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCDefaultBranchCmdlet.PassThru"> <summary> Returns the value passed to the RepositoryName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCDefaultBranchCmdlet.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.CC.UpdateCCRepositoryDescriptionCmdlet"> <summary> Sets or changes the comment or description for a repository. <note><para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCRepositoryDescriptionCmdlet.RepositoryDescription"> <summary> <para> <para>The new comment or description for the specified repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCRepositoryDescriptionCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to set or change the comment or description for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCRepositoryDescriptionCmdlet.PassThru"> <summary> Returns the value passed to the RepositoryName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCRepositoryDescriptionCmdlet.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.CC.UpdateCCRepositoryNameCmdlet"> <summary> Renames a repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCRepositoryNameCmdlet.NewName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCRepositoryNameCmdlet.OldName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CC.UpdateCCRepositoryNameCmdlet.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.CD.AddCDOnPremiseInstanceTagCmdlet"> <summary> Adds tags to on-premises instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.AddCDOnPremiseInstanceTagCmdlet.InstanceName"> <summary> <para> <para>The names of the on-premises instances to add tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.AddCDOnPremiseInstanceTagCmdlet.Tag"> <summary> <para> <para>The tag key-value pairs to add to the on-premises instances.</para><para>Keys and values are both required. Keys cannot be nulls or empty strings. Value-only tags are not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.AddCDOnPremiseInstanceTagCmdlet.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.CD.GetCDApplicationCmdlet"> <summary> Gets information about an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationListCmdlet"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list applications call, which can be used to return the next set of applications in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet"> <summary> Gets information about an application revision. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.ApplicationName"> <summary> <para> <para>The name of the application that corresponds to the revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.S3Location_Bucket"> <summary> <para> <para>The name of the Amazon S3 bucket where the application revision is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.S3Location_BundleType"> <summary> <para> <para>The file type of the application revision. Must be one of the following:</para><ul><li>tar: A tar archive file.</li><li>tgz: A compressed tar archive file.</li><li>zip: A zip archive file.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.GitHubLocation_CommitId"> <summary> <para> <para>The SHA1 commit ID of the GitHub commit that references the that represents the bundled artifacts for the application revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.S3Location_Key"> <summary> <para> <para>The name of the Amazon S3 object that represents the bundled artifacts for the application revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.GitHubLocation_Repository"> <summary> <para> <para>The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.</para><para>Specified as account/repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.Revision_RevisionType"> <summary> <para> <para>The application revision's type:</para><ul><li>S3: An application revision stored in Amazon S3.</li><li>GitHub: An application revision stored in GitHub.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.S3Location_Version"> <summary> <para> <para>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</para><para>If the version is not specified, the system will use the most recent version by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionCmdlet.S3Location_ETag"> <summary> <para> <para>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</para><para>If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionListCmdlet"> <summary> Lists information about revisions for an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionListCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionListCmdlet.Deployed"> <summary> <para> <para>Whether to list revisions based on whether the revision is the target revision of an deployment group:</para><ul><li>include: List revisions that are target revisions of a deployment group.</li><li>exclude: Do not list revisions that are target revisions of a deployment group.</li><li>ignore: List all revisions, regardless of whether they are target revisions of a deployment group.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionListCmdlet.S3Bucket"> <summary> <para> <para>A specific Amazon S3 bucket name to limit the search for revisions.</para><para>If set to null, then all of the user's buckets will be searched.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionListCmdlet.S3KeyPrefix"> <summary> <para> <para>A specific key prefix for the set of Amazon S3 objects to limit the search for revisions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionListCmdlet.SortBy"> <summary> <para> <para>The column name to sort the list results by:</para><ul><li>registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.</li><li>firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.</li><li>lastUsedTime: Sort the list results by when the revisions were last used in a deployment.</li></ul><para>If not specified or set to null, the results will be returned in an arbitrary order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionListCmdlet.SortOrder"> <summary> <para> <para>The order to sort the list results by:</para><ul><li>ascending: Sort the list of results in ascending order.</li><li>descending: Sort the list of results in descending order.</li></ul><para>If not specified, the results will be sorted in ascending order.</para><para>If set to null, the results will be sorted in an arbitrary order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationRevisionListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationsCmdlet"> <summary> Gets information about one or more applications. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDApplicationsCmdlet.ApplicationName"> <summary> <para> <para>A list of application names, with multiple application names separated by spaces.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentCmdlet"> <summary> Gets information about a deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentCmdlet.DeploymentId"> <summary> <para> <para>An existing deployment ID associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentConfigCmdlet"> <summary> Gets information about a deployment configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentConfigCmdlet.DeploymentConfigName"> <summary> <para> <para>The name of an existing deployment configuration associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentConfigListCmdlet"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentConfigListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list deployment configurations call, which can be used to return the next set of deployment configurations in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentGroupCmdlet"> <summary> Gets information about a deployment group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentGroupCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentGroupCmdlet.DeploymentGroupName"> <summary> <para> <para>The name of an existing deployment group for the specified application.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentGroupListCmdlet"> <summary> Lists the deployment groups for an application registered with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentGroupListCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentGroupListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list deployment groups call, which can be used to return the next set of deployment groups in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentInstanceCmdlet"> <summary> Gets information about an instance as part of a deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentInstanceCmdlet.DeploymentId"> <summary> <para> <para>The unique ID of a deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentInstanceCmdlet.InstanceId"> <summary> <para> <para>The unique ID of an instance in the deployment's deployment group.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentInstanceListCmdlet"> <summary> Lists the instances for a deployment associated with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentInstanceListCmdlet.DeploymentId"> <summary> <para> <para>The unique ID of a deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentInstanceListCmdlet.InstanceStatusFilter"> <summary> <para> <para>A subset of instances to list, by status:</para><ul><li>Pending: Include in the resulting list those instances with pending deployments.</li><li>InProgress: Include in the resulting list those instances with in-progress deployments.</li><li>Succeeded: Include in the resulting list those instances with succeeded deployments.</li><li>Failed: Include in the resulting list those instances with failed deployments.</li><li>Skipped: Include in the resulting list those instances with skipped deployments.</li><li>Unknown: Include in the resulting list those instances with deployments in an unknown state.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentInstanceListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list deployment instances call, which can be used to return the next set of deployment instances in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentListCmdlet"> <summary> Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentListCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentListCmdlet.DeploymentGroupName"> <summary> <para> <para>The name of an existing deployment group for the specified application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentListCmdlet.CreateTimeRange_End"> <summary> <para> <para>The time range's end time.</para><note>Specify null to leave the time range's end time open-ended.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentListCmdlet.IncludeOnlyStatus"> <summary> <para> <para>A subset of deployments to list, by status:</para><ul><li>Created: Include in the resulting list created deployments.</li><li>Queued: Include in the resulting list queued deployments.</li><li>In Progress: Include in the resulting list in-progress deployments.</li><li>Succeeded: Include in the resulting list succeeded deployments.</li><li>Failed: Include in the resulting list failed deployments.</li><li>Aborted: Include in the resulting list aborted deployments.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentListCmdlet.CreateTimeRange_Start"> <summary> <para> <para>The time range's start time.</para><note>Specify null to leave the time range's start time open-ended.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentsCmdlet"> <summary> Gets information about one or more deployments. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDDeploymentsCmdlet.DeploymentId"> <summary> <para> <para>A list of deployment IDs, with multiple deployment IDs separated by spaces.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDOnPremiseInstanceCmdlet"> <summary> Gets information about an on-premises instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDOnPremiseInstanceCmdlet.InstanceName"> <summary> <para> <para>The name of the on-premises instance to get information about</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDOnPremiseInstanceBatchCmdlet"> <summary> Gets information about one or more on-premises instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDOnPremiseInstanceBatchCmdlet.InstanceName"> <summary> <para> <para>The names of the on-premises instances to get information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.GetCDOnPremiseInstanceListCmdlet"> <summary> Gets a list of one or more on-premises instance names. <para> Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDOnPremiseInstanceListCmdlet.RegistrationStatus"> <summary> <para> <para>The on-premises instances registration status:</para><ul><li>Deregistered: Include in the resulting list deregistered on-premises instances.</li><li>Registered: Include in the resulting list registered on-premises instances.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDOnPremiseInstanceListCmdlet.TagFilter"> <summary> <para> <para>The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.GetCDOnPremiseInstanceListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CD.NewCDApplicationCmdlet"> <summary> Creates a new application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDApplicationCmdlet.ApplicationName"> <summary> <para> <para>The name of the application. This name must be unique with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDApplicationCmdlet.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.CD.NewCDDeploymentCmdlet"> <summary> Deploys an application revision through the specified deployment group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.S3Location_Bucket"> <summary> <para> <para>The name of the Amazon S3 bucket where the application revision is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.S3Location_BundleType"> <summary> <para> <para>The file type of the application revision. Must be one of the following:</para><ul><li>tar: A tar archive file.</li><li>tgz: A compressed tar archive file.</li><li>zip: A zip archive file.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.GitHubLocation_CommitId"> <summary> <para> <para>The SHA1 commit ID of the GitHub commit that references the that represents the bundled artifacts for the application revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.DeploymentConfigName"> <summary> <para> <para>The name of an existing deployment configuration associated with the applicable IAM user or AWS account.</para><para>If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.DeploymentGroupName"> <summary> <para> <para>The deployment group's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.Description"> <summary> <para> <para>A comment about the deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.IgnoreApplicationStopFailure"> <summary> <para> <para>If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event.</para><para>If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.S3Location_Key"> <summary> <para> <para>The name of the Amazon S3 object that represents the bundled artifacts for the application revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.GitHubLocation_Repository"> <summary> <para> <para>The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.</para><para>Specified as account/repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.Revision_RevisionType"> <summary> <para> <para>The application revision's type:</para><ul><li>S3: An application revision stored in Amazon S3.</li><li>GitHub: An application revision stored in GitHub.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.S3Location_Version"> <summary> <para> <para>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</para><para>If the version is not specified, the system will use the most recent version by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.S3Location_ETag"> <summary> <para> <para>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</para><para>If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentCmdlet.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.CD.NewCDDeploymentConfigCmdlet"> <summary> Creates a new deployment configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentConfigCmdlet.DeploymentConfigName"> <summary> <para> <para>The name of the deployment configuration to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentConfigCmdlet.MinimumHealthyHosts_Type"> <summary> <para> <para>The minimum healthy instances type:</para><ul><li>HOST_COUNT: The minimum number of healthy instances, as an absolute value.</li><li>FLEET_PERCENT: The minimum number of healthy instances, as a percentage of the total number of instances in the deployment.</li></ul><para>For example, for 9 instances, if a HOST_COUNT of 6 is specified, deploy to up to 3 instances at a time. The deployment succeeds if 6 or more instances are successfully deployed to; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to 5 instances at a time. The deployment succeeds if 4 or more instances are successfully deployed to; otherwise, the deployment fails.</para><note>In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instances type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instances at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.)</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentConfigCmdlet.MinimumHealthyHosts_Value"> <summary> <para> <para>The minimum healthy instances value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentConfigCmdlet.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.CD.NewCDDeploymentGroupCmdlet"> <summary> Creates a new deployment group for application revisions to be deployed to. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentGroupCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentGroupCmdlet.AutoScalingGroup"> <summary> <para> <para>A list of associated Auto Scaling groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentGroupCmdlet.DeploymentConfigName"> <summary> <para> <para>If specified, the deployment configuration name must be one of the predefined values, or it can be a custom deployment configuration:</para><ul><li>CodeDeployDefault.AllAtOnce deploys an application revision to up to all of the instances at once. The overall deployment succeeds if the application revision deploys to at least one of the instances. The overall deployment fails after the application revision fails to deploy to all of the instances. For example, for 9 instances, deploy to up to all 9 instances at once. The overall deployment succeeds if any of the 9 instances is successfully deployed to, and it fails if all 9 instances fail to be deployed to.</li><li>CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for 9 instances, deploy to up to 4 instances at a time. The overall deployment succeeds if 5 or more instances are successfully deployed to; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails.</li><li>CodeDeployDefault.OneAtATime deploys the application revision to only one of the instances at a time. The overall deployment succeeds if the application revision deploys to all of the instances. The overall deployment fails after the application revision first fails to deploy to any one instances. For example, for 9 instances, deploy to one instance at a time. The overall deployment succeeds if all 9 instances are successfully deployed to, and it fails if any of one of the 9 instances fail to be deployed to. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. This is the default deployment configuration if a configuration isn't specified for either the deployment or the deployment group.</li></ul><para>To create a custom deployment configuration, call the create deployment configuration operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentGroupCmdlet.DeploymentGroupName"> <summary> <para> <para>The name of an existing deployment group for the specified application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentGroupCmdlet.Ec2TagFilter"> <summary> <para> <para>The Amazon EC2 tags to filter on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentGroupCmdlet.OnPremisesInstanceTagFilter"> <summary> <para> <para>The on-premises instance tags to filter on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentGroupCmdlet.ServiceRoleArn"> <summary> <para> <para>A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.NewCDDeploymentGroupCmdlet.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.CD.RegisterCDApplicationRevisionCmdlet"> <summary> Registers with AWS CodeDeploy a revision for the specified application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.S3Location_Bucket"> <summary> <para> <para>The name of the Amazon S3 bucket where the application revision is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.S3Location_BundleType"> <summary> <para> <para>The file type of the application revision. Must be one of the following:</para><ul><li>tar: A tar archive file.</li><li>tgz: A compressed tar archive file.</li><li>zip: A zip archive file.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.GitHubLocation_CommitId"> <summary> <para> <para>The SHA1 commit ID of the GitHub commit that references the that represents the bundled artifacts for the application revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.Description"> <summary> <para> <para>A comment about the revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.S3Location_Key"> <summary> <para> <para>The name of the Amazon S3 object that represents the bundled artifacts for the application revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.GitHubLocation_Repository"> <summary> <para> <para>The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.</para><para>Specified as account/repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.Revision_RevisionType"> <summary> <para> <para>The application revision's type:</para><ul><li>S3: An application revision stored in Amazon S3.</li><li>GitHub: An application revision stored in GitHub.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.S3Location_Version"> <summary> <para> <para>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</para><para>If the version is not specified, the system will use the most recent version by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.S3Location_ETag"> <summary> <para> <para>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</para><para>If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.PassThru"> <summary> Returns the value passed to the ApplicationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDApplicationRevisionCmdlet.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.CD.RegisterCDOnPremiseInstanceCmdlet"> <summary> Registers an on-premises instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDOnPremiseInstanceCmdlet.IamUserArn"> <summary> <para> <para>The ARN of the IAM user to associate with the on-premises instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDOnPremiseInstanceCmdlet.InstanceName"> <summary> <para> <para>The name of the on-premises instance to register.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RegisterCDOnPremiseInstanceCmdlet.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.CD.RemoveCDApplicationCmdlet"> <summary> Deletes an application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDApplicationCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDApplicationCmdlet.PassThru"> <summary> Returns the value passed to the ApplicationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDApplicationCmdlet.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.CD.RemoveCDDeploymentConfigCmdlet"> <summary> Deletes a deployment configuration. <note>A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDDeploymentConfigCmdlet.DeploymentConfigName"> <summary> <para> <para>The name of an existing deployment configuration associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDDeploymentConfigCmdlet.PassThru"> <summary> Returns the value passed to the DeploymentConfigName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDDeploymentConfigCmdlet.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.CD.RemoveCDDeploymentGroupCmdlet"> <summary> Deletes a deployment group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDDeploymentGroupCmdlet.ApplicationName"> <summary> <para> <para>The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDDeploymentGroupCmdlet.DeploymentGroupName"> <summary> <para> <para>The name of an existing deployment group for the specified application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDDeploymentGroupCmdlet.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.CD.RemoveCDOnPremiseInstanceTagCmdlet"> <summary> Removes one or more tags from one or more on-premises instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDOnPremiseInstanceTagCmdlet.InstanceName"> <summary> <para> <para>The names of the on-premises instances to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDOnPremiseInstanceTagCmdlet.Tag"> <summary> <para> <para>The tag key-value pairs to remove from the on-premises instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.RemoveCDOnPremiseInstanceTagCmdlet.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.CD.StopCDDeploymentCmdlet"> <summary> Attempts to stop an ongoing deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.StopCDDeploymentCmdlet.DeploymentId"> <summary> <para> <para>The unique ID of a deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.StopCDDeploymentCmdlet.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.CD.UnregisterCDOnPremiseInstanceCmdlet"> <summary> Deregisters an on-premises instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UnregisterCDOnPremiseInstanceCmdlet.InstanceName"> <summary> <para> <para>The name of the on-premises instance to deregister.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UnregisterCDOnPremiseInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UnregisterCDOnPremiseInstanceCmdlet.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.CD.UpdateCDApplicationCmdlet"> <summary> Changes an existing application's name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDApplicationCmdlet.ApplicationName"> <summary> <para> <para>The current name of the application that you want to change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDApplicationCmdlet.NewApplicationName"> <summary> <para> <para>The new name that you want to change the application to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDApplicationCmdlet.PassThru"> <summary> Returns the value passed to the ApplicationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDApplicationCmdlet.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.CD.UpdateCDDeploymentGroupCmdlet"> <summary> Changes information about an existing deployment group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.ApplicationName"> <summary> <para> <para>The application name corresponding to the deployment group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.AutoScalingGroup"> <summary> <para> <para>The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.CurrentDeploymentGroupName"> <summary> <para> <para>The current name of the existing deployment group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.DeploymentConfigName"> <summary> <para> <para>The replacement deployment configuration name to use, if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.Ec2TagFilter"> <summary> <para> <para>The replacement set of Amazon EC2 tags to filter on, if you want to change them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.NewDeploymentGroupName"> <summary> <para> <para>The new name of the deployment group, if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.OnPremisesInstanceTagFilter"> <summary> <para> <para>The replacement set of on-premises instance tags for filter on, if you want to change them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.ServiceRoleArn"> <summary> <para> <para>A replacement service role's ARN, if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CD.UpdateCDDeploymentGroupCmdlet.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.CP.ConfirmCPJobCmdlet"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.ConfirmCPJobCmdlet.JobId"> <summary> <para> <para>The unique system-generated ID of the job for which you want to confirm receipt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.ConfirmCPJobCmdlet.Nonce"> <summary> <para> <para>A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.ConfirmCPJobCmdlet.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.CP.ConfirmCPThirdPartyJobCmdlet"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.ConfirmCPThirdPartyJobCmdlet.ClientToken"> <summary> <para> <para>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.ConfirmCPThirdPartyJobCmdlet.JobId"> <summary> <para> <para>The unique system-generated ID of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.ConfirmCPThirdPartyJobCmdlet.Nonce"> <summary> <para> <para>A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.ConfirmCPThirdPartyJobCmdlet.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.CP.DisableCPStageTransitionCmdlet"> <summary> Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.DisableCPStageTransitionCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.DisableCPStageTransitionCmdlet.Reason"> <summary> <para> <para>The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.DisableCPStageTransitionCmdlet.StageName"> <summary> <para> <para>The name of the stage where you want to disable the inbound or outbound transition of artifacts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.DisableCPStageTransitionCmdlet.TransitionType"> <summary> <para> <para>Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.DisableCPStageTransitionCmdlet.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.CP.EnableCPStageTransitionCmdlet"> <summary> Enables artifacts in a pipeline to transition to a stage in a pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.EnableCPStageTransitionCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.EnableCPStageTransitionCmdlet.StageName"> <summary> <para> <para>The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.EnableCPStageTransitionCmdlet.TransitionType"> <summary> <para> <para>Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.EnableCPStageTransitionCmdlet.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.CP.GetCPActionableJobsCmdlet"> <summary> Returns information about any jobs for AWS CodePipeline to act upon. <important><para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableJobsCmdlet.ActionTypeId_Category"> <summary> <para> <para>A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableJobsCmdlet.MaxBatchSize"> <summary> <para> <para>The maximum number of jobs to return in a poll for jobs call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableJobsCmdlet.ActionTypeId_Provider"> <summary> <para> <para>The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableJobsCmdlet.QueryParam"> <summary> <para> <para>A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableJobsCmdlet.ActionTypeId_Version"> <summary> <para> <para>A string that identifies the action type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableJobsCmdlet.ActionTypeId_Owner"> <summary> <para> <para>The creator of the action being called. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CP.GetCPActionableThirdPartyJobsCmdlet"> <summary> Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions. <important><para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableThirdPartyJobsCmdlet.ActionTypeId_Category"> <summary> <para> <para>A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableThirdPartyJobsCmdlet.MaxBatchSize"> <summary> <para> <para>The maximum number of jobs to return in a poll for jobs call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableThirdPartyJobsCmdlet.ActionTypeId_Provider"> <summary> <para> <para>The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableThirdPartyJobsCmdlet.ActionTypeId_Version"> <summary> <para> <para>A string that identifies the action type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionableThirdPartyJobsCmdlet.ActionTypeId_Owner"> <summary> <para> <para>The creator of the action being called. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CP.GetCPActionTypeCmdlet"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionTypeCmdlet.ActionOwnerFilter"> <summary> <para> <para>Filters the list of action types to those created by a specified entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPActionTypeCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CP.GetCPJobDetailsCmdlet"> <summary> Returns information about a job. Only used for custom actions. <important><para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPJobDetailsCmdlet.JobId"> <summary> <para> <para>The unique system-generated ID for the job.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CP.GetCPPipelineCmdlet"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPPipelineCmdlet.Name"> <summary> <para> <para>The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPPipelineCmdlet.Version"> <summary> <para> <para>The version number of the pipeline. If you do not specify a version, defaults to the most current version.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CP.GetCPPipelineListCmdlet"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPPipelineListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CP.GetCPPipelineStateCmdlet"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPPipelineStateCmdlet.Name"> <summary> <para> <para>The name of the pipeline about which you want to get information.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CP.GetCPThirdPartyJobDetailsCmdlet"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important><para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPThirdPartyJobDetailsCmdlet.ClientToken"> <summary> <para> <para>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.GetCPThirdPartyJobDetailsCmdlet.JobId"> <summary> <para> <para>The unique system-generated ID used for identifying the job.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet"> <summary> Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.Category"> <summary> <para> <para>The category of the custom action, such as a source action or a build action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.ConfigurationProperty"> <summary> <para> <para>The configuration properties for the custom action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.Settings_EntityUrlTemplate"> <summary> <para> <para>The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.Settings_ExecutionUrlTemplate"> <summary> <para> <para>The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.InputArtifactDetails_MaximumCount"> <summary> <para> <para>The maximum number of artifacts allowed for the action type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.OutputArtifactDetails_MaximumCount"> <summary> <para> <para>The maximum number of artifacts allowed for the action type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.InputArtifactDetails_MinimumCount"> <summary> <para> <para>The minimum number of artifacts allowed for the action type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.OutputArtifactDetails_MinimumCount"> <summary> <para> <para>The minimum number of artifacts allowed for the action type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.Provider"> <summary> <para> <para>The provider of the service used in the custom action, such as AWS CodeDeploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.Settings_RevisionUrlTemplate"> <summary> <para> <para>The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.Settings_ThirdPartyConfigurationUrl"> <summary> <para> <para>The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.Version"> <summary> <para> <para>The version number of the custom action. </para><note>A newly-created custom action is always assigned a version number of <code>1</code>. This is required.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPCustomActionTypeCmdlet.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.CP.NewCPPipelineCmdlet"> <summary> Creates a pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPPipelineCmdlet.Pipeline"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.NewCPPipelineCmdlet.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.CP.RemoveCPCustomActionTypeCmdlet"> <summary> Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions. <important><para> You cannot recreate a custom action after it has been deleted unless you increase the version number of the action. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.RemoveCPCustomActionTypeCmdlet.Category"> <summary> <para> <para>The category of the custom action that you want to delete, such as source or deploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.RemoveCPCustomActionTypeCmdlet.Provider"> <summary> <para> <para>The provider of the service used in the custom action, such as AWS CodeDeploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.RemoveCPCustomActionTypeCmdlet.Version"> <summary> <para> <para>The version of the custom action to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.RemoveCPCustomActionTypeCmdlet.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.CP.RemoveCPPipelineCmdlet"> <summary> Deletes the specified pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.RemoveCPPipelineCmdlet.Name"> <summary> <para> <para>The name of the pipeline to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.RemoveCPPipelineCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.RemoveCPPipelineCmdlet.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.CP.StartCPPipelineExecutionCmdlet"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.StartCPPipelineExecutionCmdlet.Name"> <summary> <para> <para>The name of the pipeline to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.StartCPPipelineExecutionCmdlet.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.CP.UpdateCPPipelineCmdlet"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.UpdateCPPipelineCmdlet.Pipeline"> <summary> <para> <para>The name of the pipeline to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.UpdateCPPipelineCmdlet.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.CP.WriteCPActionRevisionCmdlet"> <summary> Provides information to AWS CodePipeline about new revisions to a source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPActionRevisionCmdlet.ActionName"> <summary> <para> <para>The name of the action that will process the revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPActionRevisionCmdlet.ActionRevision_Created"> <summary> <para> <para>The date and time when the most recent version of the action was created, in timestamp format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPActionRevisionCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline that will start processing the revision to the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPActionRevisionCmdlet.ActionRevision_RevisionChangeId"> <summary> <para> <para>The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPActionRevisionCmdlet.ActionRevision_RevisionId"> <summary> <para> <para>The system-generated unique ID that identifies the revision number of the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPActionRevisionCmdlet.StageName"> <summary> <para> <para>The name of the stage that contains the action that will act upon the revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPActionRevisionCmdlet.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.CP.WriteCPJobFailureResultCmdlet"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobFailureResultCmdlet.FailureDetails_ExternalExecutionId"> <summary> <para> <para>The external ID of the run of the action that failed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobFailureResultCmdlet.JobId"> <summary> <para> <para>The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobFailureResultCmdlet.FailureDetails_Message"> <summary> <para> <para>The message about the failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobFailureResultCmdlet.FailureDetails_Type"> <summary> <para> <para>The type of the failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobFailureResultCmdlet.PassThru"> <summary> Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobFailureResultCmdlet.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.CP.WriteCPJobSuccessResultCmdlet"> <summary> Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.CurrentRevision_ChangeIdentifier"> <summary> <para> <para>The change identifier for the current revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.ContinuationToken"> <summary> <para> <para>A system-generated token, such as a AWS CodeDeploy deployment ID, that the successful job used to complete a job asynchronously. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.ExecutionDetails_ExternalExecutionId"> <summary> <para> <para>The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.JobId"> <summary> <para> <para>The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.ExecutionDetails_PercentComplete"> <summary> <para> <para>The percentage of work completed on the action, represented on a scale of zero to one hundred percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.CurrentRevision_Revision"> <summary> <para> <para>The revision ID of the current version of an artifact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.ExecutionDetails_Summary"> <summary> <para> <para>The summary of the current status of the actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.PassThru"> <summary> Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPJobSuccessResultCmdlet.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.CP.WriteCPThirdPartyJobFailureResultCmdlet"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobFailureResultCmdlet.ClientToken"> <summary> <para> <para>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobFailureResultCmdlet.FailureDetails_ExternalExecutionId"> <summary> <para> <para>The external ID of the run of the action that failed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobFailureResultCmdlet.JobId"> <summary> <para> <para>The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobFailureResultCmdlet.FailureDetails_Message"> <summary> <para> <para>The message about the failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobFailureResultCmdlet.FailureDetails_Type"> <summary> <para> <para>The type of the failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobFailureResultCmdlet.PassThru"> <summary> Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobFailureResultCmdlet.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.CP.WriteCPThirdPartyJobSuccessResultCmdlet"> <summary> Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.CurrentRevision_ChangeIdentifier"> <summary> <para> <para>The change identifier for the current revision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.ClientToken"> <summary> <para> <para>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.ContinuationToken"> <summary> <para> <para>A system-generated token, such as a AWS CodeDeploy deployment ID, that a job uses in order to continue the job asynchronously.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.ExecutionDetails_ExternalExecutionId"> <summary> <para> <para>The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.JobId"> <summary> <para> <para>The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.ExecutionDetails_PercentComplete"> <summary> <para> <para>The percentage of work completed on the action, represented on a scale of zero to one hundred percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.CurrentRevision_Revision"> <summary> <para> <para>The revision ID of the current version of an artifact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.ExecutionDetails_Summary"> <summary> <para> <para>The summary of the current status of the actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.PassThru"> <summary> Returns the value passed to the JobId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CP.WriteCPThirdPartyJobSuccessResultCmdlet.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.CGI.GetCGIIdentityPoolCmdlet"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolCmdlet.IdentityPoolId"> <summary> <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolListCmdlet"> <summary> Lists all of the Cognito identity pools registered for your account. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolListCmdlet.MaxResult"> <summary> <para> The maximum number of identities to return. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolListCmdlet.NextToken"> <summary> <para> A pagination token. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolRoleCmdlet"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.GetCGIIdentityPoolRoleCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet"> <summary> Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for <code>SupportedLoginProviders</code> are as follows: <ul><li>Facebook: <code>graph.facebook.com</code></li><li>Google: <code>accounts.google.com</code></li><li>Amazon: <code>www.amazon.com</code></li><li>Twitter: <code>api.twitter.com</code></li><li>Digits: <code>www.digits.com</code></li></ul> You must use AWS Developer credentials to call this API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.AllowUnauthenticatedIdentity"> <summary> <para> <para>TRUE if the identity pool supports unauthenticated logins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.DeveloperProviderName"> <summary> <para> <para>The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well as period (<code>.</code>), underscore (<code>_</code>), and dash (<code>-</code>).</para><para>Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.IdentityPoolName"> <summary> <para> <para>A string that you provide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.OpenIdConnectProviderARNs"> <summary> <para> <para>A list of OpendID Connect provider ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.SupportedLoginProvider"> <summary> <para> <para>Optional key:value pairs mapping provider names to provider app IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.NewCGIIdentityPoolCmdlet.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.CGI.RemoveCGIIdentityPoolCmdlet"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityPoolCmdlet.IdentityPoolId"> <summary> <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityPoolCmdlet.PassThru"> <summary> Returns the value passed to the IdentityPoolId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.RemoveCGIIdentityPoolCmdlet.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.CGI.SetCGIIdentityPoolRoleCmdlet"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.IdentityPoolId"> <summary> <para> <para>An identity pool ID in the format REGION:GUID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.Role"> <summary> <para> <para>The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.PassThru"> <summary> Returns the value passed to the IdentityPoolId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.SetCGIIdentityPoolRoleCmdlet.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.CGI.UpdateCGIIdentityPoolCmdlet"> <summary> Updates a user pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.AllowUnauthenticatedIdentity"> <summary> <para> TRUE if the identity pool supports unauthenticated logins. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.DeveloperProviderName"> <summary> <para> <para>The "domain" by which Cognito will refer to your users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.IdentityPoolId"> <summary> <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.IdentityPoolName"> <summary> <para> <para>A string that you provide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.OpenIdConnectProviderARNs"> <summary> <para> <para>A list of OpendID Connect provider ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.SupportedLoginProvider"> <summary> <para> <para>Optional key:value pairs mapping provider names to provider app IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGI.UpdateCGIIdentityPoolCmdlet.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.CFG.GetCFGComplianceByConfigRuleCmdlet"> <summary> Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. <para> A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply. </para><para> If AWS Config has no current evaluation results for the rule, it returns <code>InsufficientData</code>. This result might indicate one of the following conditions: <ul><li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li><li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li><li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByConfigRuleCmdlet.ComplianceType"> <summary> <para> <para>Filters the results by compliance. The valid values are <code>Compliant</code> and <code>NonCompliant</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByConfigRuleCmdlet.ConfigRuleName"> <summary> <para> <para>Specify one or more AWS Config rule names to filter the results by rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByConfigRuleCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet"> <summary> Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. <para> A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. </para><para> If AWS Config has no current evaluation results for the resource, it returns <code>InsufficientData</code>. This result might indicate one of the following conditions about the rules that evaluate the resource: <ul><li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li><li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li><li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.ComplianceType"> <summary> <para> <para>Filters the results by compliance. The valid values are <code>Compliant</code> and <code>NonCompliant</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.ResourceId"> <summary> <para> <para>The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for <code>ResourceType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.ResourceType"> <summary> <para> <para>The types of AWS resources for which you want compliance information; for example, <code>AWS::EC2::Instance</code>. For this action, you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.Limit"> <summary> <para> <para>The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceByResourceCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet"> <summary> Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.ComplianceType"> <summary> <para> <para>Specify to filter the results by compliance. The valid values are <code>Compliant</code>, <code>NonCompliant</code>, and <code>NotApplicable</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule for which you want compliance information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.Limit"> <summary> <para> <para>The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByConfigRuleCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet"> <summary> Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet.ComplianceType"> <summary> <para> <para>Specify to filter the results by compliance. The valid values are <code>Compliant</code>, <code>NonCompliant</code>, and <code>NotApplicable</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet.ResourceId"> <summary> <para> <para>The ID of the AWS resource for which you want compliance information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet.ResourceType"> <summary> <para> <para>The type of the AWS resource for which you want compliance information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceDetailsByResourceCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceSummaryByConfigRuleCmdlet"> <summary> Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceSummaryByResourceTypeCmdlet"> <summary> Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGComplianceSummaryByResourceTypeCmdlet.ResourceType"> <summary> <para> <para>Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.</para><para>For this request, you can specify an AWS resource type such as <code>AWS::EC2::Instance</code>, and you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRuleEvaluationStatusCmdlet"> <summary> Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRuleEvaluationStatusCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRulesCmdlet"> <summary> Returns details about your AWS Config rules. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRulesCmdlet.ConfigRuleName"> <summary> <para> <para>The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigRulesCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecordersCmdlet"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note><para> Currently, you can specify only one configuration recorder per account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecordersCmdlet.ConfigurationRecorderName"> <summary> <para> <para>A list of configuration recorder names.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecorderStatusCmdlet"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGConfigurationRecorderStatusCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelsCmdlet"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note><para> Currently, you can specify only one delivery channel per account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelsCmdlet.DeliveryChannelName"> <summary> <para> <para>A list of delivery channel names.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelStatusCmdlet"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDeliveryChannelStatusCmdlet.DeliveryChannelName"> <summary> <para> <para>A list of delivery channel names.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet"> <summary> Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. <note>You can specify either resource IDs or a resource name but not both in the same request.</note><para> The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.IncludeDeletedResource"> <summary> <para> <para>Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.ResourceId"> <summary> <para> <para>The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.ResourceName"> <summary> <para> <para>The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.ResourceType"> <summary> <para> <para>The type of resources that you want AWS Config to list in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.Limit"> <summary> <para> <para>The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGDiscoveredResourceCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet"> <summary> Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. <para> The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para><note><para> Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.ChronologicalOrder"> <summary> <para> <para>The chronological order for configuration items listed. By default the results are listed in reverse chronological order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.EarlierTime"> <summary> <para> <para>The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start from when the first configuration item was recorded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.LaterTime"> <summary> <para> <para>The time stamp that indicates a later time. If not specified, current time is taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.ResourceId"> <summary> <para> <para>The ID of the resource (for example., <code>sg-xxxxxx</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.ResourceType"> <summary> <para> <para>The resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.Limit"> <summary> <para> <para>The maximum number of configuration items returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.GetCFGResourceConfigHistoryCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigRuleCmdlet"> <summary> Deletes the specified AWS Config rule and all of its evaluation results. <para> AWS Config sets the state of a rule to <code>DELETING</code> until the deletion is complete. You cannot update a rule while it is in this state. If you make a <code>PutConfigRule</code> request for the rule, you will receive a <code>ResourceInUseException</code>. </para><para> You can check the state of a rule by using the <code>DescribeConfigRules</code> request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigRuleCmdlet.ConfigRuleName"> <summary> <para> <para>The name of the AWS Config rule that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigRuleCmdlet.PassThru"> <summary> Returns the value passed to the ConfigRuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGConfigRuleCmdlet.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.CFG.RemoveCFGDeliveryChannelCmdlet"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGDeliveryChannelCmdlet.DeliveryChannelName"> <summary> <para> <para>The name of the delivery channel to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGDeliveryChannelCmdlet.PassThru"> <summary> Returns the value passed to the DeliveryChannelName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.RemoveCFGDeliveryChannelCmdlet.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.CFG.StartCFGConfigurationRecorderCmdlet"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigurationRecorderCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name of the recorder object that records each configuration change made to the resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StartCFGConfigurationRecorderCmdlet.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.CFG.StopCFGConfigurationRecorderCmdlet"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StopCFGConfigurationRecorderCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name of the recorder object that records each configuration change made to the resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.StopCFGConfigurationRecorderCmdlet.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.CFG.SubmitCFGConfigSnapshotDeliveryCmdlet"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul><li>Notification of starting the delivery.</li><li>Notification of delivery completed, if the delivery was successfully completed.</li><li>Notification of delivery failure, if the delivery failed to complete.</li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SubmitCFGConfigSnapshotDeliveryCmdlet.DeliveryChannelName"> <summary> <para> <para>The name of the delivery channel through which the snapshot is delivered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.SubmitCFGConfigSnapshotDeliveryCmdlet.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.CFG.WriteCFGConfigRuleCmdlet"> <summary> Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. <para> You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config. </para><para> If you are adding a new customer managed Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </para><para> If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>. </para><para> For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules. </para><para> If you are updating a rule that you have added previously, specify the rule's <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request. </para><para> The maximum number of rules that AWS Config supports is 25. </para><para> For more information about developing and using AWS Config rules, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>. </para><para></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Scope_ComplianceResourceId"> <summary> <para> <para>The IDs of only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a resource ID, you must specify one resource type for <code>ComplianceResourceTypes</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Scope_ComplianceResourceType"> <summary> <para> <para>The resource types of only those AWS resources that you want AWS Config to evaluate against the rule. You can specify only one type if you also specify resource IDs for <code>ComplianceResourceId</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_ConfigRuleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_ConfigRuleId"> <summary> <para> <para>The ID of the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_ConfigRuleName"> <summary> <para> <para>The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_ConfigRuleState"> <summary> <para> <para>Indicates whether the AWS Config rule is active or currently being deleted by AWS Config.</para><para>AWS Config sets the state of a rule to <code>DELETING</code> temporarily after you use the <code>DeleteConfigRule</code> request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available.</para><para>You cannot add a rule to AWS Config that has the state set to <code>DELETING</code>. If you want to delete a rule, you must use the <code>DeleteConfigRule</code> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_Description"> <summary> <para> <para>The description that you provide for the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_InputParameter"> <summary> <para> <para>A string in JSON format that is passed to the AWS Config rule Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.ConfigRule_MaximumExecutionFrequency"> <summary> <para> <para>The maximum frequency at which the AWS Config rule runs evaluations.</para><para>If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the <code>MaximumExecutionFrequency</code> key to be equal to or greater than the value of the <code>deliveryFrequency</code> key, which is part of <code>ConfigSnapshotDeliveryProperties</code>. To update the frequency with which AWS Config delivers your snapshots, use the <code>PutDeliveryChannel</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Source_SourceDetail"> <summary> <para> <para>Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Source_SourceIdentifier"> <summary> <para> <para>For AWS managed Config rules, a pre-defined identifier from a list. To reference the list, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>.</para><para>For customer managed Config rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Scope_TagKey"> <summary> <para> <para>The tag key that is applied to only those AWS resources that you want AWS Config to evaluate against the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Scope_TagValue"> <summary> <para> <para>The tag value applied to only those AWS resources that you want AWS Config to evaluate against the rule. If you specify a value for <code>TagValue</code>, you must also specify a value for <code>TagKey</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.Source_Owner"> <summary> <para> <para>Indicates whether AWS or the customer owns and manages the AWS Config rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.PassThru"> <summary> Returns the value passed to the ConfigRule_ConfigRuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigRuleCmdlet.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.CFG.WriteCFGConfigurationRecorderCmdlet"> <summary> Creates a new configuration recorder to record the selected resource configurations. <para> You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. </para><note><para> Currently, you can specify only one configuration recorder per account. </para><para> If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.RecordingGroup_AllSupported"> <summary> <para> <para>Records all supported resource types in the recording group. For a list of supported resource types, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported resource types</a>. If you specify <b>allSupported</b>, you cannot enumerate a list of <b>resourceTypes</b>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.ConfigurationRecorderName"> <summary> <para> <para>The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.RecordingGroup_ResourceType"> <summary> <para> <para>A comma-separated list of strings representing valid AWS resource types (for example, <code>AWS::EC2::Instance</code> or <code>AWS::CloudTrail::Trail</code>). <b>resourceTypes</b> is only valid if you have chosen not to select <b>allSupported</b>. For a list of valid <b>resourceTypes</b> values, see the <b>resourceType Value</b> column in the following topic: <a href="http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported AWS Resource Types</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.ConfigurationRecorder_RoleARN"> <summary> <para> <para>Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.PassThru"> <summary> Returns the value passed to the ConfigurationRecorderName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGConfigurationRecorderCmdlet.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.CFG.WriteCFGDeliveryChannelCmdlet"> <summary> Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic. <para> You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. </para><note><para> Currently, you can specify only one delivery channel per account. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.ConfigSnapshotDeliveryProperties_DeliveryFrequency"> <summary> <para> <para>The frequency with which a AWS Config recurringly delivers configuration snapshots.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.DeliveryChannelName"> <summary> <para> <para>The name of the delivery channel. By default, AWS Config automatically assigns the name "default" when creating the delivery channel. You cannot change the assigned name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.DeliveryChannel_S3BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket used to store configuration history for the delivery channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.DeliveryChannel_S3KeyPrefix"> <summary> <para> <para>The prefix for the specified Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.DeliveryChannel_SnsTopicARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SNS topic that AWS Config delivers notifications to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.PassThru"> <summary> Returns the value passed to the DeliveryChannelName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGDeliveryChannelCmdlet.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.CFG.WriteCFGEvaluationsCmdlet"> <summary> Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGEvaluationsCmdlet.Evaluation"> <summary> <para> <para>The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGEvaluationsCmdlet.ResultToken"> <summary> <para> <para>An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFG.WriteCFGEvaluationsCmdlet.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.DP.AddDPTagsCmdlet"> <summary> Adds or modifies tags for the specified pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.AddDPTagsCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.AddDPTagsCmdlet.Tag"> <summary> <para> <para>The tags to add, as key/value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.AddDPTagsCmdlet.PassThru"> <summary> Returns the value passed to the PipelineId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.AddDPTagsCmdlet.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.DP.DisableDPPipelineCmdlet"> <summary> Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code> state until the deactivation process completes. <para> To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.DisableDPPipelineCmdlet.CancelActive"> <summary> <para> <para>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.DisableDPPipelineCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.DisableDPPipelineCmdlet.PassThru"> <summary> Returns the value passed to the PipelineId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.DisableDPPipelineCmdlet.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.DP.EnableDPPipelineCmdlet"> <summary> Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. <para> If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call <a>DeactivatePipeline</a>. </para><para> To activate a finished pipeline, modify the end date for the pipeline and then activate it. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.EnableDPPipelineCmdlet.ParameterValue"> <summary> <para> <para>A list of parameter values to pass to the pipeline at activation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.EnableDPPipelineCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.EnableDPPipelineCmdlet.StartTimestamp"> <summary> <para> <para>The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.EnableDPPipelineCmdlet.PassThru"> <summary> Returns the value passed to the PipelineId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.EnableDPPipelineCmdlet.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.DP.FindDPObjectCmdlet"> <summary> Queries the specified pipeline for the names of objects that match the specified set of conditions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.FindDPObjectCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.FindDPObjectCmdlet.Query_Selector"> <summary> <para> <para>List of selectors that define the query. An object must satisfy all of the selectors to match the query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.FindDPObjectCmdlet.Sphere"> <summary> <para> <para>Indicates whether the query applies to components or instances. The possible values are: <code>COMPONENT</code>, <code>INSTANCE</code>, and <code>ATTEMPT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.FindDPObjectCmdlet.Limit"> <summary> <para> <para>The maximum number of object names that <code>QueryObjects</code> will return in a single call. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.FindDPObjectCmdlet.Marker"> <summary> <para> <para>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>QueryObjects</code> with the marker value from the previous call to retrieve the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DP.GetDPObjectCmdlet"> <summary> Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPObjectCmdlet.EvaluateExpression"> <summary> <para> <para>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPObjectCmdlet.ObjectId"> <summary> <para> <para>The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPObjectCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline that contains the object definitions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPObjectCmdlet.Marker"> <summary> <para> <para>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DP.GetDPPipelineCmdlet"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPPipelineCmdlet.Marker"> <summary> <para> <para>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>ListPipelines</code> with the marker value from the previous call to retrieve the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DP.GetDPPipelineDefinitionCmdlet"> <summary> Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve the pipeline definition that you provided using <a>PutPipelineDefinition</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPPipelineDefinitionCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPPipelineDefinitionCmdlet.Version"> <summary> <para> <para>The version of the pipeline definition to retrieve. Set this parameter to <code>latest</code> (default) to use the last definition saved to the pipeline or <code>active</code> to use the last definition that was activated.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DP.GetDPPipelineDescriptionCmdlet"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPPipelineDescriptionCmdlet.PipelineId"> <summary> <para> <para>The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DP.GetDPTaskCmdlet"> <summary> Task runners call <code>PollForTask</code> to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that match the <code>workerGroup</code> value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. <para> If tasks are ready in the work queue, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue, <code>PollForTask</code> uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPTaskCmdlet.InstanceIdentity_Document"> <summary> <para> <para>A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPTaskCmdlet.Hostname"> <summary> <para> <para>The public DNS name of the calling task runner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPTaskCmdlet.InstanceIdentity_Signature"> <summary> <para> <para>A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.GetDPTaskCmdlet.WorkerGroup"> <summary> <para> <para>The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <code>workerGroup</code> in the call to <code>PollForTask</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string must be an exact, case-sensitive, match.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DP.InvokeDPExpressionCmdlet"> <summary> Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.InvokeDPExpressionCmdlet.Expression"> <summary> <para> <para>The expression to evaluate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.InvokeDPExpressionCmdlet.ObjectId"> <summary> <para> <para>The ID of the object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.InvokeDPExpressionCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.InvokeDPExpressionCmdlet.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.DP.NewDPPipelineCmdlet"> <summary> Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.NewDPPipelineCmdlet.Description"> <summary> <para> <para>The description for the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.NewDPPipelineCmdlet.Name"> <summary> <para> <para>The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.NewDPPipelineCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.NewDPPipelineCmdlet.UniqueId"> <summary> <para> <para>A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to <code>CreatePipeline</code>. For example, if the first call to <code>CreatePipeline</code> does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to <code>CreatePipeline</code>. <code>CreatePipeline</code> ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.NewDPPipelineCmdlet.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.DP.RemoveDPPipelineCmdlet"> <summary> Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. <para> Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components. Components that are paused by <a>SetStatus</a> can be resumed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.RemoveDPPipelineCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.RemoveDPPipelineCmdlet.PassThru"> <summary> Returns the value passed to the PipelineId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.RemoveDPPipelineCmdlet.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.DP.RemoveDPTagsCmdlet"> <summary> Removes existing tags from the specified pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.RemoveDPTagsCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.RemoveDPTagsCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.RemoveDPTagsCmdlet.PassThru"> <summary> Returns the value passed to the PipelineId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.RemoveDPTagsCmdlet.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.DP.SetDPStatusCmdlet"> <summary> Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPStatusCmdlet.ObjectId"> <summary> <para> <para>The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPStatusCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline that contains the objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPStatusCmdlet.Status"> <summary> <para> <para>The status to be set on all the objects specified in <code>objectIds</code>. For components, use <code>PAUSE</code> or <code>RESUME</code>. For instances, use <code>TRY_CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPStatusCmdlet.PassThru"> <summary> Returns the object ids. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPStatusCmdlet.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.DP.SetDPTaskStatusCmdlet"> <summary> Task runners call <code>SetTaskStatus</code> to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPTaskStatusCmdlet.ErrorId"> <summary> <para> <para>If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPTaskStatusCmdlet.ErrorMessage"> <summary> <para> <para>If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPTaskStatusCmdlet.ErrorStackTrace"> <summary> <para> <para>If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPTaskStatusCmdlet.TaskId"> <summary> <para> <para>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPTaskStatusCmdlet.TaskStatus"> <summary> <para> <para>If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code>, the task ended unsuccessfully. Preconditions use false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPTaskStatusCmdlet.PassThru"> <summary> Returns the value passed to the TaskId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.SetDPTaskStatusCmdlet.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.DP.TestDPPipelineDefinitionCmdlet"> <summary> Validates the specified pipeline definition to ensure that it is well formed and can be run without error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.TestDPPipelineDefinitionCmdlet.ParameterObject"> <summary> <para> <para>The parameter objects used with the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.TestDPPipelineDefinitionCmdlet.ParameterValue"> <summary> <para> <para>The parameter values used with the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.TestDPPipelineDefinitionCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.TestDPPipelineDefinitionCmdlet.PipelineObject"> <summary> <para> <para>The objects that define the pipeline changes to validate against the pipeline.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DP.UpdateDPTaskProgressCmdlet"> <summary> Task runners call <code>ReportTaskProgress</code> when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline. <para> If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60 seconds. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.UpdateDPTaskProgressCmdlet.Field"> <summary> <para> <para>Key-value pairs that define the properties of the ReportTaskProgressInput object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.UpdateDPTaskProgressCmdlet.TaskId"> <summary> <para> <para>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.UpdateDPTaskProgressCmdlet.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.DP.UpdateDPTaskRunnerHeartbeatCmdlet"> <summary> Task runners call <code>ReportTaskRunnerHeartbeat</code> every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.UpdateDPTaskRunnerHeartbeatCmdlet.Hostname"> <summary> <para> <para>The public DNS name of the task runner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.UpdateDPTaskRunnerHeartbeatCmdlet.TaskrunnerId"> <summary> <para> <para>The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.UpdateDPTaskRunnerHeartbeatCmdlet.WorkerGroup"> <summary> <para> <para>The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <code>workerGroup</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string must be an exact, case-sensitive, match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.UpdateDPTaskRunnerHeartbeatCmdlet.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.DP.WriteDPPipelineDefinitionCmdlet"> <summary> Adds tasks, schedules, and preconditions to the specified pipeline. You can use <code>PutPipelineDefinition</code> to populate a new pipeline. <para><code>PutPipelineDefinition</code> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. </para><ol><li>An object is missing a name or identifier field.</li><li>A string or reference field is empty.</li><li>The number of objects in the pipeline exceeds the maximum allowed objects.</li><li>The pipeline is in a FINISHED state.</li></ol><para> Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.WriteDPPipelineDefinitionCmdlet.ParameterObject"> <summary> <para> <para>The parameter objects used with the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.WriteDPPipelineDefinitionCmdlet.ParameterValue"> <summary> <para> <para>The parameter values used with the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.WriteDPPipelineDefinitionCmdlet.PipelineId"> <summary> <para> <para>The ID of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.WriteDPPipelineDefinitionCmdlet.PipelineObject"> <summary> <para> <para>The objects that define the pipeline. These objects overwrite the existing pipeline definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DP.WriteDPPipelineDefinitionCmdlet.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.DF.GetDFAccountSettingListCmdlet"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFArtifactListCmdlet"> <summary> Gets information about artifacts. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFArtifactListCmdlet.Arn"> <summary> <para> <para>The Run, Job, Suite, or Test ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFArtifactListCmdlet.Type"> <summary> <para> <para>The artifacts' type.</para><para>Allowed values include:</para><ul><li>FILE: The artifacts are files.</li><li>LOG: The artifacts are logs.</li><li>SCREENSHOT: The artifacts are screenshots.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFArtifactListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFDeviceCmdlet"> <summary> Gets information about a unique device type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDeviceCmdlet.Arn"> <summary> <para> <para>The device type's ARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFDeviceListCmdlet"> <summary> Gets information about unique device types. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDeviceListCmdlet.Arn"> <summary> <para> <para>The device types' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDeviceListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolCmdlet"> <summary> Gets information about a device pool. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolCmdlet.Arn"> <summary> <para> <para>The device pool's ARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolCompatibilityCmdlet"> <summary> Gets information about compatibility with a device pool. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolCompatibilityCmdlet.AppArn"> <summary> <para> <para>The ARN of the app that is associated with the specified device pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolCompatibilityCmdlet.DevicePoolArn"> <summary> <para> <para>The device pool's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolCompatibilityCmdlet.TestType"> <summary> <para> <para>The test type for the specified device pool.</para><para>Allowed values include the following:</para><ul><li><para>BUILTIN_FUZZ: The built-in fuzz type.</para></li><li><para>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</para></li><li><para>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</para></li><li><para>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</para></li><li><para>CALABASH: The Calabash type.</para></li><li><para>INSTRUMENTATION: The Instrumentation type.</para></li><li><para>UIAUTOMATION: The uiautomation type.</para></li><li><para>UIAUTOMATOR: The uiautomator type.</para></li><li><para>XCTEST: The XCode test type.</para></li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolListCmdlet"> <summary> Gets information about device pools. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolListCmdlet.Arn"> <summary> <para> <para>The project ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolListCmdlet.Type"> <summary> <para> <para>The device pools' type.</para><para>Allowed values include:</para><ul><li><para>CURATED: A device pool that is created and managed by AWS Device Farm.</para></li><li><para>PRIVATE: A device pool that is created and managed by the device pool developer.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFDevicePoolListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFJobCmdlet"> <summary> Gets information about a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFJobCmdlet.Arn"> <summary> <para> <para>The job's ARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFJobListCmdlet"> <summary> Gets information about jobs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFJobListCmdlet.Arn"> <summary> <para> <para>The jobs' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFJobListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFProjectCmdlet"> <summary> Gets information about a project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFProjectCmdlet.Arn"> <summary> <para> <para>The project's ARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFProjectListCmdlet"> <summary> Gets information about projects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFProjectListCmdlet.Arn"> <summary> <para> <para>The projects' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFProjectListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFRunCmdlet"> <summary> Gets information about a run. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFRunCmdlet.Arn"> <summary> <para> <para>The run's ARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFRunListCmdlet"> <summary> Gets information about runs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFRunListCmdlet.Arn"> <summary> <para> <para>The runs' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFRunListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFSampleListCmdlet"> <summary> Gets information about samples. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFSampleListCmdlet.Arn"> <summary> <para> <para>The samples' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFSampleListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFSuiteCmdlet"> <summary> Gets information about a suite. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFSuiteCmdlet.Arn"> <summary> <para> <para>The suite's ARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFSuiteListCmdlet"> <summary> Gets information about suites. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFSuiteListCmdlet.Arn"> <summary> <para> <para>The suites' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFSuiteListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFTestCmdlet"> <summary> Gets information about a test. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFTestCmdlet.Arn"> <summary> <para> <para>The test's ARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFTestListCmdlet"> <summary> Gets information about tests. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFTestListCmdlet.Arn"> <summary> <para> <para>The tests' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFTestListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFUniqueProblemListCmdlet"> <summary> Gets information about unique problems. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFUniqueProblemListCmdlet.Arn"> <summary> <para> <para>The unique problems' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFUniqueProblemListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFUploadCmdlet"> <summary> Gets information about an upload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFUploadCmdlet.Arn"> <summary> <para> <para>The upload's ARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.GetDFUploadListCmdlet"> <summary> Gets information about uploads. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFUploadListCmdlet.Arn"> <summary> <para> <para>The uploads' ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.GetDFUploadListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DF.NewDFDevicePoolCmdlet"> <summary> Creates a device pool. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFDevicePoolCmdlet.Description"> <summary> <para> <para>The device pool's description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFDevicePoolCmdlet.Name"> <summary> <para> <para>The device pool's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFDevicePoolCmdlet.ProjectArn"> <summary> <para> <para>The ARN of the project for the device pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFDevicePoolCmdlet.Rule"> <summary> <para> <para>The device pool's rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFDevicePoolCmdlet.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.DF.NewDFProjectCmdlet"> <summary> Creates a new project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFProjectCmdlet.Name"> <summary> <para> <para>The project's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFProjectCmdlet.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.DF.NewDFUploadCmdlet"> <summary> Uploads an app or test scripts. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFUploadCmdlet.ContentType"> <summary> <para> <para>The upload's content type (for example, "application/octet-stream").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFUploadCmdlet.Name"> <summary> <para> <para>The upload's file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFUploadCmdlet.ProjectArn"> <summary> <para> <para>The ARN of the project for the upload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFUploadCmdlet.Type"> <summary> <para> <para>The upload's upload type.</para><para>Must be one of the following values:</para><ul><li><para>ANDROID_APP: An Android upload.</para></li><li><para>IOS_APP: An iOS upload.</para></li><li><para>EXTERNAL_DATA: An external data upload.</para></li><li><para>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</para></li><li><para>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</para></li><li><para>CALABASH_TEST_PACKAGE: A Calabash test package upload.</para></li><li><para>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</para></li><li><para>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</para></li><li><para>XCTEST_TEST_PACKAGE: An XCode test package upload.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.NewDFUploadCmdlet.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.DF.SubmitDFTestRunCmdlet"> <summary> Schedules a run. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.AppArn"> <summary> <para> <para>The ARN of the app to schedule a run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Configuration_AuxiliaryApp"> <summary> <para> <para>A list of auxiliary apps for the run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Configuration_BillingMethod"> <summary> <para> <para>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>unmetered</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Radios_Bluetooth"> <summary> <para> <para>True if Bluetooth is enabled at the beginning of the test; otherwise, false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.DevicePoolArn"> <summary> <para> <para>The ARN of the device pool for the run to be scheduled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Configuration_ExtraDataPackageArn"> <summary> <para> <para>The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Test_Filter"> <summary> <para> <para>The test's filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Radios_Gp"> <summary> <para> <para>True if GPS is enabled at the beginning of the test; otherwise, false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Location_Latitude"> <summary> <para> <para>The latitude.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Configuration_Locale"> <summary> <para> <para>Information about the locale that is used for the run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Location_Longitude"> <summary> <para> <para>The longitude.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Name"> <summary> <para> <para>The name for the run to be scheduled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Configuration_NetworkProfileArn"> <summary> <para> <para>Reserved for internal use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Radios_Nfc"> <summary> <para> <para>True if NFC is enabled at the beginning of the test; otherwise, false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Test_Parameter"> <summary> <para> <para>The test's parameters, such as test framework parameters and fixture settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.ProjectArn"> <summary> <para> <para>The ARN of the project for the run to be scheduled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Test_TestPackageArn"> <summary> <para> <para>The ARN of the uploaded test that will be run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Test_Type"> <summary> <para> <para>The test's type.</para><para>Must be one of the following values:</para><ul><li><para>BUILTIN_FUZZ: The built-in fuzz type.</para></li><li><para>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</para></li><li><para>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</para></li><li><para>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</para></li><li><para>CALABASH: The Calabash type.</para></li><li><para>INSTRUMENTATION: The Instrumentation type.</para></li><li><para>UIAUTOMATION: The uiautomation type.</para></li><li><para>UIAUTOMATOR: The uiautomator type.</para></li><li><para>XCTEST: The XCode test type.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.Radios_Wifi"> <summary> <para> <para>True if Wi-Fi is enabled at the beginning of the test; otherwise, false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DF.SubmitDFTestRunCmdlet.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.DC.ConfirmDCConnectionCmdlet"> <summary> Confirm the creation of a hosted connection on an interconnect. <para> Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.ConfirmDCConnectionCmdlet.ConnectionId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.ConfirmDCConnectionCmdlet.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.DC.ConfirmDCPrivateVirtualInterfaceCmdlet"> <summary> Accept ownership of a private virtual interface created by another customer. <para> After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.ConfirmDCPrivateVirtualInterfaceCmdlet.VirtualGatewayId"> <summary> <para> <para>ID of the virtual private gateway that will be attached to the virtual interface.</para><para> A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action.</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.ConfirmDCPrivateVirtualInterfaceCmdlet.VirtualInterfaceId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.ConfirmDCPrivateVirtualInterfaceCmdlet.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.DC.ConfirmDCPublicVirtualInterfaceCmdlet"> <summary> Accept ownership of a public virtual interface created by another customer. <para> After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.ConfirmDCPublicVirtualInterfaceCmdlet.VirtualInterfaceId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.ConfirmDCPublicVirtualInterfaceCmdlet.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.DC.EnableDCConnectionOnInterconnectCmdlet"> <summary> Creates a hosted connection on an interconnect. <para> Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCConnectionOnInterconnectCmdlet.Bandwidth"> <summary> <para> <para>Bandwidth of the connection.</para><para>Example: "<i>500Mbps</i>"</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCConnectionOnInterconnectCmdlet.ConnectionName"> <summary> <para> <para>Name of the provisioned connection.</para><para>Example: "<i>500M Connection to AWS</i>"</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCConnectionOnInterconnectCmdlet.InterconnectId"> <summary> <para> <para>ID of the interconnect on which the connection will be provisioned.</para><para>Example: dxcon-456abc78</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCConnectionOnInterconnectCmdlet.OwnerAccount"> <summary> <para> <para>Numeric account Id of the customer for whom the connection will be provisioned.</para><para>Example: 123443215678</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCConnectionOnInterconnectCmdlet.Vlan"> <summary> <para> <para>The dedicated VLAN provisioned to the connection.</para><para>Example: 101</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCConnectionOnInterconnectCmdlet.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.DC.EnableDCPrivateVirtualInterfaceCmdlet"> <summary> Provisions a private virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer. </para><para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterfaceAllocation_AmazonAddress"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterfaceAllocation_Asn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterfaceAllocation_AuthKey"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.ConnectionId"> <summary> <para> <para>The connection ID on which the private virtual interface is provisioned.</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterfaceAllocation_CustomerAddress"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.OwnerAccount"> <summary> <para> <para>The AWS account that will own the new private virtual interface.</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterfaceAllocation_VirtualInterfaceName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterfaceAllocation_Vlan"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPrivateVirtualInterfaceCmdlet.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.DC.EnableDCPublicVirtualInterfaceCmdlet"> <summary> Provisions a public virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer. </para><para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterfaceAllocation_AmazonAddress"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterfaceAllocation_Asn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterfaceAllocation_AuthKey"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.ConnectionId"> <summary> <para> <para>The connection ID on which the public virtual interface is provisioned.</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterfaceAllocation_CustomerAddress"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.OwnerAccount"> <summary> <para> <para>The AWS account that will own the new public virtual interface.</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterfaceAllocation_RouteFilterPrefix"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterfaceAllocation_VirtualInterfaceName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterfaceAllocation_Vlan"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.EnableDCPublicVirtualInterfaceCmdlet.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.DC.GetDCConnectionCmdlet"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.GetDCConnectionCmdlet.ConnectionId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DC.GetDCConnectionsOnInterconnectCmdlet"> <summary> Return a list of connections that have been provisioned on the given interconnect. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.GetDCConnectionsOnInterconnectCmdlet.InterconnectId"> <summary> <para> <para>ID of the interconnect on which a list of connection is provisioned.</para><para>Example: dxcon-abc123</para><para>Default: None</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DC.GetDCInterconnectCmdlet"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.GetDCInterconnectCmdlet.InterconnectId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DC.GetDCLocationsCmdlet"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DC.GetDCVirtualGatewayCmdlet"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DC.GetDCVirtualInterfaceCmdlet"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para><para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.GetDCVirtualInterfaceCmdlet.ConnectionId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.GetDCVirtualInterfaceCmdlet.VirtualInterfaceId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DC.NewDCConnectionCmdlet"> <summary> Creates a new connection between the customer network and a specific AWS Direct Connect location. <para> A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCConnectionCmdlet.Bandwidth"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCConnectionCmdlet.ConnectionName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCConnectionCmdlet.Location"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCConnectionCmdlet.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.DC.NewDCInterconnectCmdlet"> <summary> Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location. <para> An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router. </para><para> For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCInterconnectCmdlet.Bandwidth"> <summary> <para> <para>The port bandwidth</para><para>Example: 1Gbps</para><para>Default: None</para><para>Available values: 1Gbps,10Gbps</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCInterconnectCmdlet.InterconnectName"> <summary> <para> <para>The name of the interconnect.</para><para>Example: "<i>1G Interconnect to AWS</i>"</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCInterconnectCmdlet.Location"> <summary> <para> <para>Where the interconnect is located</para><para>Example: EqSV5</para><para>Default: None</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCInterconnectCmdlet.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.DC.NewDCPrivateVirtualInterfaceCmdlet"> <summary> Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterface_AmazonAddress"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterface_Asn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterface_AuthKey"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.ConnectionId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterface_CustomerAddress"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterface_VirtualGatewayId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterface_VirtualInterfaceName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.NewPrivateVirtualInterface_Vlan"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPrivateVirtualInterfaceCmdlet.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.DC.NewDCPublicVirtualInterfaceCmdlet"> <summary> Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterface_AmazonAddress"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterface_Asn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterface_AuthKey"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.ConnectionId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterface_CustomerAddress"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterface_RouteFilterPrefix"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterface_VirtualInterfaceName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.NewPublicVirtualInterface_Vlan"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.NewDCPublicVirtualInterfaceCmdlet.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.DC.RemoveDCConnectionCmdlet"> <summary> Deletes the connection. <para> Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.RemoveDCConnectionCmdlet.ConnectionId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.RemoveDCConnectionCmdlet.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.DC.RemoveDCInterconnectCmdlet"> <summary> Deletes the specified interconnect. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.RemoveDCInterconnectCmdlet.InterconnectId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.RemoveDCInterconnectCmdlet.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.DC.RemoveDCVirtualInterfaceCmdlet"> <summary> Deletes a virtual interface. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.RemoveDCVirtualInterfaceCmdlet.VirtualInterfaceId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DC.RemoveDCVirtualInterfaceCmdlet.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.DS.ConnectDSDirectoryCmdlet"> <summary> Creates an AD Connector to connect an on-premises directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.ConnectSettings_CustomerDnsIp"> <summary> <para> <para>A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.ConnectSettings_CustomerUserName"> <summary> <para> <para>The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges:</para><ul><li>Read users and groups</li><li>Create computer objects</li><li>Join computers to the domain</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.Description"> <summary> <para> <para>A textual description for the directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.Name"> <summary> <para> <para>The fully-qualified name of the on-premises directory, such as <code>corp.example.com</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.Password"> <summary> <para> <para>The password for the on-premises user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.ShortName"> <summary> <para> <para>The NetBIOS name of the on-premises directory, such as <code>CORP</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.Size"> <summary> <para> <para>The size of the directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.ConnectSettings_SubnetId"> <summary> <para> <para>A list of subnet identifiers in the VPC that the AD Connector is created in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.ConnectSettings_VpcId"> <summary> <para> <para>The identifier of the VPC that the AD Connector is created in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.ConnectDSDirectoryCmdlet.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.DS.DisableDSRadiusCmdlet"> <summary> Disables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.DisableDSRadiusCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to disable MFA for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.DisableDSRadiusCmdlet.PassThru"> <summary> Returns the value passed to the DirectoryId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.DisableDSRadiusCmdlet.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.DS.DisableDSSsoCmdlet"> <summary> Disables single-sign on for a directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.DisableDSSsoCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to disable single-sign on for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.DisableDSSsoCmdlet.Password"> <summary> <para> <para>The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. See the <i>UserName</i> parameter for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.DisableDSSsoCmdlet.UserName"> <summary> <para> <para>The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principle name. </para><para>If the AD Connector service account does not have privileges to remove a service principle name, you can specify an alternate account with the <i>UserName</i> and <i>Password</i> parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.DisableDSSsoCmdlet.PassThru"> <summary> Returns the value passed to the DirectoryId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.DisableDSSsoCmdlet.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.DS.EnableDSRadiusCmdlet"> <summary> Enables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.RadiusSettings_AuthenticationProtocol"> <summary> <para> <para>The protocol specified for your RADIUS endpoints.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to enable MFA for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.RadiusSettings_DisplayLabel"> <summary> <para> <para>Not currently used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.RadiusSettings_RadiusPort"> <summary> <para> <para>The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.RadiusSettings_RadiusRetry"> <summary> <para> <para>The maximum number of times that communication with the RADIUS server is attempted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.RadiusSettings_RadiusServer"> <summary> <para> <para>An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.RadiusSettings_RadiusTimeout"> <summary> <para> <para>The amount of time, in seconds, to wait for the RADIUS server to respond.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.RadiusSettings_SharedSecret"> <summary> <para> <para>The shared secret code that was specified when your RADIUS endpoints were created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.RadiusSettings_UseSameUsername"> <summary> <para> <para>Not currently used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.PassThru"> <summary> Returns the value passed to the DirectoryId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSRadiusCmdlet.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.DS.EnableDSSsoCmdlet"> <summary> Enables single-sign on for a directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSSsoCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to enable single-sign on for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSSsoCmdlet.Password"> <summary> <para> <para>The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. See the <i>UserName</i> parameter for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSSsoCmdlet.UserName"> <summary> <para> <para>The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principle name. </para><para>If the AD Connector service account does not have privileges to add a service principle name, you can specify an alternate account with the <i>UserName</i> and <i>Password</i> parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSSsoCmdlet.PassThru"> <summary> Returns the value passed to the DirectoryId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.EnableDSSsoCmdlet.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.DS.GetDSDirectoryCmdlet"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para><para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para><para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.GetDSDirectoryCmdlet.DirectoryId"> <summary> <para> <para>A list of identifiers of the directories to obtain the information for. If this member is null, all directories that belong to the current account are returned.</para><para>An empty list results in an <code>InvalidParameterException</code> being thrown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.GetDSDirectoryCmdlet.Limit"> <summary> <para> <para>The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.GetDSDirectoryCmdlet.NextToken"> <summary> <para> <para>The <i>DescribeDirectoriesResult.NextToken</i> value from a previous call to <a>DescribeDirectories</a>. Pass null if this is the first call.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DS.GetDSDirectoryLimitCmdlet"> <summary> Obtains directory limit information for the current region. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DS.GetDSSnapshotCmdlet"> <summary> Obtains information about the directory snapshots that belong to this account. <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of items. </para><para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.GetDSSnapshotCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to retrieve snapshot information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.GetDSSnapshotCmdlet.SnapshotId"> <summary> <para> <para>A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the <i>Limit</i> and <i>NextToken</i> members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.GetDSSnapshotCmdlet.Limit"> <summary> <para> <para>The maximum number of objects to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.GetDSSnapshotCmdlet.NextToken"> <summary> <para> <para>The <i>DescribeSnapshotsResult.NextToken</i> value from a previous call to <a>DescribeSnapshots</a>. Pass null if this is the first call.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DS.GetDSSnapshotLimitCmdlet"> <summary> Obtains the manual snapshot limits for a directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.GetDSSnapshotLimitCmdlet.DirectoryId"> <summary> <para> <para>Contains the identifier of the directory to obtain the limits for.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DS.NewDSAliasCmdlet"> <summary> Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http://<alias>.awsapps.com</code>. <important><para> After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSAliasCmdlet.Alias"> <summary> <para> <para>The requested alias.</para><para>The alias must be unique amongst all aliases in AWS. This operation will throw an <code>EntityAlreadyExistsException</code> if this alias already exists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSAliasCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to create the alias for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSAliasCmdlet.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.DS.NewDSComputerCmdlet"> <summary> Creates a computer account in the specified directory, and joins the computer to the directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSComputerCmdlet.ComputerAttribute"> <summary> <para> <para>An array of <a>Attribute</a> objects that contain any LDAP attributes to apply to the computer account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSComputerCmdlet.ComputerName"> <summary> <para> <para>The name of the computer account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSComputerCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to create the computer account in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSComputerCmdlet.OrganizationalUnitDistinguishedName"> <summary> <para> <para>The fully-qualified distinguished name of the organizational unit to place the computer account in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSComputerCmdlet.Password"> <summary> <para> <para>A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSComputerCmdlet.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.DS.NewDSDirectoryCmdlet"> <summary> Creates a Simple AD directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSDirectoryCmdlet.Description"> <summary> <para> <para>A textual description for the directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSDirectoryCmdlet.Name"> <summary> <para> <para>The fully qualified name for the directory, such as <code>corp.example.com</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSDirectoryCmdlet.Password"> <summary> <para> <para>The password for the directory administrator. The directory creation process creates a directory administrator account with the username <code>Administrator</code> and this password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSDirectoryCmdlet.ShortName"> <summary> <para> <para>The short name of the directory, such as <code>CORP</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSDirectoryCmdlet.Size"> <summary> <para> <para>The size of the directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSDirectoryCmdlet.VpcSettings_SubnetId"> <summary> <para> <para>The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSDirectoryCmdlet.VpcSettings_VpcId"> <summary> <para> <para>The identifier of the VPC to create the Simple AD directory in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSDirectoryCmdlet.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.DS.NewDSSnapshotCmdlet"> <summary> Creates a snapshot of an existing directory. <para> You cannot take snapshots of extended or connected directories. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSSnapshotCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to take a snapshot of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSSnapshotCmdlet.Name"> <summary> <para> <para>The descriptive name to apply to the snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.NewDSSnapshotCmdlet.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.DS.RemoveDSDirectoryCmdlet"> <summary> Deletes an AWS Directory Service directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.RemoveDSDirectoryCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.RemoveDSDirectoryCmdlet.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.DS.RemoveDSSnapshotCmdlet"> <summary> Deletes a directory snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.RemoveDSSnapshotCmdlet.SnapshotId"> <summary> <para> <para>The identifier of the directory snapshot to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.RemoveDSSnapshotCmdlet.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.DS.RestoreDSFromSnapshotCmdlet"> <summary> Restores a directory using an existing directory snapshot. <para> When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. </para><para> This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is complete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.RestoreDSFromSnapshotCmdlet.SnapshotId"> <summary> <para> <para>The identifier of the snapshot to restore from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.RestoreDSFromSnapshotCmdlet.PassThru"> <summary> Returns the value passed to the SnapshotId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.RestoreDSFromSnapshotCmdlet.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.DS.UpdateDSRadiusCmdlet"> <summary> Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.RadiusSettings_AuthenticationProtocol"> <summary> <para> <para>The protocol specified for your RADIUS endpoints.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.DirectoryId"> <summary> <para> <para>The identifier of the directory to update the RADIUS server information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.RadiusSettings_DisplayLabel"> <summary> <para> <para>Not currently used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.RadiusSettings_RadiusPort"> <summary> <para> <para>The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.RadiusSettings_RadiusRetry"> <summary> <para> <para>The maximum number of times that communication with the RADIUS server is attempted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.RadiusSettings_RadiusServer"> <summary> <para> <para>An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.RadiusSettings_RadiusTimeout"> <summary> <para> <para>The amount of time, in seconds, to wait for the RADIUS server to respond.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.RadiusSettings_SharedSecret"> <summary> <para> <para>The shared secret code that was specified when your RADIUS endpoints were created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.RadiusSettings_UseSameUsername"> <summary> <para> <para>Not currently used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.PassThru"> <summary> Returns the value passed to the DirectoryId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DS.UpdateDSRadiusCmdlet.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.DDB.GetDDBStreamCmdlet"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note><para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para></note><para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamCmdlet.ExclusiveStartShardId"> <summary> <para> <para>The shard ID of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedShardId</code> in the previous operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamCmdlet.StreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamCmdlet.Limit"> <summary> <para> <para>The maximum number of shard objects to return. The upper limit is 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamListCmdlet"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note><para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamListCmdlet.ExclusiveStartStreamArn"> <summary> <para> <para>The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedStreamArn</code> in the previous operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamListCmdlet.TableName"> <summary> <para> <para>If this parameter is provided, then only the streams associated with this table name are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamListCmdlet.Limit"> <summary> <para> <para>The maximum number of streams to return. The upper limit is 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet"> <summary> <para> Adds a new Amazon DynamoDB local or global secondary index schema property to the supplied object, or returns a new object initialized with the index schema. </para> <para> The default behavior of this cmdlet is to create a local secondary index. To specify that the index is global, use the -Global switch and also add the ReadCapacity and WriteCapacity parameters to indicate the required throughput for the index. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.Schema"> <summary> A previously constructed TableSchema object to which the new index schema element will be added. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.IndexName"> <summary> The name of the secondary index. Must be unique only for this table that will be created. If an index with the same name already exists on the pipelined object an error is thrown. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.RangeKeyName"> <summary> The name of the range key to add to the secondary index. This is a mandatory parameter for local indexes. Global indexes can be defined with either a range key or a hash key, either of which can be any attribute in the table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.RangeKeyDataType"> <summary> The data type of the range key as specified by the Amazon DynamoDB api. This is a mandatory parameter for local indexes. Global indexes can be defined with either a range key or a hash key, either of which can be any attribute in the table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.ProjectionType"> <summary> Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Valid values: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are specified with the -NonKeyAttribute parameter. ALL - All of the table attributes are projected into the index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.NonKeyAttribute"> <summary> A collection of one or more non-key attribute names that are projected into the index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.Global"> <summary> If set, specifies that the index components described by the parameters should be added as a global secondary index entry. The ReadCapacity and WriteCapacity parameters are also required when defining a global index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.HashKeyName"> <summary> The name of the hash key for the global secondary index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.HashKeyDataType"> <summary> The data type of the hash key for the global index, as specified by the Amazon DynamoDB api. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.ReadCapacity"> <summary> The provisioned throughput setting for read operations on the secondary index if the index is global (the -Global switch is specified). Ignored for local secondary indexes (the default). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.WriteCapacity"> <summary> The provisioned throughput setting for write operations on the secondary index if the index is global (the -Global switch is specified). Ignored for local secondary indexes (the default). </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet"> <summary> Adds a new Amazon DynamoDB KeySchemaElement instance to the supplied TableSchema object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet.Schema"> <summary> A previously constructed object to which the new key schema element will be added to any attached KeySchema property collection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet.KeyName"> <summary> The name of the key to be applied to the schema. If a key with the specified name already exists an error is thrown. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet.KeyType"> <summary> The key type. Valid values are "HASH" or "RANGE". If not specified, "HASH" is assumed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet.KeyDataType"> <summary> <para> The data type of the key as specified by the Amazon DynamoDB api. If an attribute entry for the key already exists in the attribute definitions of the supplied schema object, this parameter can be omitted otherwise an attribute will be added and defined as the declared type. </para> <para> Valid values for data type: "S" string, "N" number or "B" binary. </para> </summary> </member> <member name="M:Amazon.PowerShell.Cmdlets.DDB.DDBSchemaCmdletHelper.TableSchemaFromParameter(System.Object)"> <summary> Returns the schema object to manipulate. </summary> <param name="inputObjectParameter"> The pipeline object supplied as the value of the -Schema parameter or piped into cmdlet. </param> <returns> The supplied object as TableSchema. </returns> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet"> <summary> <para>The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.</para><para><i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, Amazon DynamoDB immediately returns a response with a <i>TableStatus</i> of <c>CREATING</c> . After the table is created, Amazon DynamoDB sets the <i>TableStatus</i> to <c>ACTIVE</c> . You can perform read and write operations only on an <c>ACTIVE</c> table. </para><para>If you want to create multiple tables with local secondary indexes on them, you must create them sequentially. Only one table with local secondary indexes can be in the <c>CREATING</c> state at any given time.</para><para>You can use the <i>DescribeTable</i> API to check the table status.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.TableName"> <summary> <para> The name of the table to create. </para> <para> <b>Constraints:</b><list type="definition"><item><term>Length</term><description>3 - 255</description></item><item><term>Pattern</term><description>[a-zA-Z0-9_.-]+</description></item></list> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.Schema"> <summary> TableSchema object containing the attribute and key schema information for the new table using the Write-DDBKeySchema and Write-DDBIndexSchema cmdlets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.ReadCapacity"> <summary> <para> The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithDDTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Constraints:</b><list type="definition"><item><term>Range</term><description>1 - </description></item></list> </para> <para> The settings can be modified using the <i>Update-DDBTable</i> cmdlet. For current minimum and maximum provisioned throughput values, see Limits in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.WriteCapacity"> <summary> <para> The maximum number of strongly consistent writes consumed per second before Amazon DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithDDTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Constraints:</b><list type="definition"><item><term>Range</term><description>1 - </description></item></list> </para> <para> The settings can be modified using the <i>Update-DDBTable</i> cmdlet. For current minimum and maximum provisioned throughput values, see Limits in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.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.DDB.NewDDBTableSchemaCmdlet"> <summary> Returns a new TableSchema object for constructing an Amazon DynamoDB key schema for use with New-DDBTable. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBTableCmdlet"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note><para> If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBTableCmdlet.TableName"> <summary> <para> <para> The name of the table to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBTablesCmdlet"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBTablesCmdlet.ExclusiveStartTableName"> <summary> <para> <para>The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBTablesCmdlet.Limit"> <summary> <para> <para> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBTableCmdlet"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note><para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para></note><para> When you delete a table, any indexes on that table are also deleted. </para><para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para><para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBTableCmdlet.TableName"> <summary> <para> <para> The name of the table to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBTableCmdlet.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.DDB.UpdateDDBTableCmdlet"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para><ul><li><para> Modify the provisioned throughput settings of the table. </para></li><li><para> Enable or disable Streams on the table. </para></li><li><para> Remove a global secondary index from the table. </para></li><li><para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para></li></ul><para><i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.AttributeDefinition"> <summary> <para> <para>An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, <i>AttributeDefinitions</i> must include the key element(s) of the new index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.GlobalSecondaryIndexUpdate"> <summary> <para> <para>An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:</para><ul><li><para><i>Create</i> - add a new global secondary index to the table.</para></li><li><para><i>Update</i> - modify the provisioned throughput settings of an existing global secondary index.</para></li><li><para><i>Delete</i> - remove a global secondary index from the table.</para></li></ul><para>For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html">Managing Global Secondary Indexes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.ReadCapacity"> <summary> <para> <para>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.StreamSpecification_StreamEnabled"> <summary> <para> <para>Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.StreamSpecification_StreamViewType"> <summary> <para> <para>The DynamoDB Streams settings for the table. These settings consist of:</para><ul><li><para><i>StreamEnabled</i> - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.</para></li><li><para><i>StreamViewType</i> - When an item in the table is modified, <i>StreamViewType</i> determines what information is written to the stream for this table. Valid values for <i>StreamViewType</i> are:</para><ul><li><para><i>KEYS_ONLY</i> - Only the key attributes of the modified item are written to the stream.</para></li><li><para><i>NEW_IMAGE</i> - The entire item, as it appears after it was modified, is written to the stream.</para></li><li><para><i>OLD_IMAGE</i> - The entire item, as it appeared before it was modified, is written to the stream.</para></li><li><para><i>NEW_AND_OLD_IMAGES</i> - Both the new and the old item images of the item are written to the stream.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.TableName"> <summary> <para> <para>The name of the table to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.WriteCapacity"> <summary> <para> <para>The maximum number of writes consumed per second before DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.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.DDB.Model.TableSchema"> <summary> Model class carrying details of an Amazon DynamoDB table schema under construction for use with the New-DDBTable cmdlet. This class is accepted as pipeline input by the schema builder cmdlets (Write-DDBAttributeSchema, Write-DDBKeySchema and Write-DDBIndexSchema). </summary> </member> <member name="M:Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema.#ctor(Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema)"> <summary> Constructs a new table schema from a deep copy of the suppled object. Used to support ICloneable. </summary> <param name="source"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema.SetLocalSecondaryIndex(System.String,System.String,System.String,System.String,System.String[])"> <summary> Adds a new local secondary index or updates an index if it has been defined already </summary> <param name="indexName"></param> <param name="rangeKeyName"></param> <param name="rangeKeyDataType"></param> <param name="projectionType"></param> <param name="nonKeyAttributes"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema.SetGlobalSecondaryIndex(System.String,System.String,System.String,System.String,System.String,System.Int64,System.Int64,System.String,System.String[])"> <summary> Adds a new global secondary index or updates an index if it has been defined already. </summary> <param name="indexName"></param> <param name="hashKeyName"></param> <param name="hashKeyDataType"></param> <param name="rangeKeyName"></param> <param name="rangeKeyDataType"></param> <param name="readCapacityUnits"></param> <param name="writeCapacityUnits"></param> <param name="projectionType"></param> <param name="nonKeyAttributes"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.EC2.AmazonEC2Helper.InstanceParamToIDs(System.Object[])"> <summary> Converts a list of string instance ids, RunningInstance objects or Reservation objects to a collection of string instance ids </summary> <param name="instances"></param> <returns></returns> </member> <member name="F:Amazon.PowerShell.Cmdlets.EC2.EC2ImportCmdletsBase.ParamSet_Default"> <summary> The default parameter set for the cmdlet causes the local artifacts to be uploaded to a named bucket, with optional key prefix, in Amazon S3 and an ImportInstance request be submitted to Amazon EC2. The conversion task object returned by EC2 is output. </summary> </member> <member name="F:Amazon.PowerShell.Cmdlets.EC2.EC2ImportCmdletsBase.ParamSet_UploadOnly"> <summary> Use of this parameter set causes the local artifacts to be uploaded to a named bucket, with optional key prefix, in Amazon S3. No import is requested and the key of the uploaded manifest is returned. </summary> </member> <member name="F:Amazon.PowerShell.Cmdlets.EC2.EC2ImportCmdletsBase.ParamSet_FromManifest"> <summary> Use of this parameter set causes an ImportInstance request to be sent to Amazon EC2 using the manifest and image file artifacts previously uploaded. The conversion task object returned by EC2 is output. </summary> </member> <member name="M:Amazon.PowerShell.Cmdlets.EC2.EC2ImportCmdletsBase.ConstructMemoFilename(System.String,System.String)"> <summary> Returns what should be a predictable and unique name for the image file that we can use to hold temporary memo data between cmdlet executions. As it is unlikely that a user will try and upload two images with the same name but different paths at the same time, and both uploads fail, a simple MD5 hash onto the image filename and path should be sufficient. </summary> <remarks> As we only know the user key prefix at the time we write the memo and not when reading due to detecting the -Resume switch, we cannot include the prefix in the hash. </remarks> <param name="imageFilePath">The resolved path to the image file</param> <param name="bucketName">The name of the bucket containing the manifest</param> <returns></returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.EC2.EC2ImportCmdletsBase.ReadManifestKeyFromMemo(System.String,System.String)"> <summary> Reads the previously stashed S3 object key to a manifest associated with the image file. The key was stored when an upload error was detected. </summary> <param name="imageFilePath">The resolved path to the image file</param> <param name="bucketName">The name of the bucket containing the manifest</param> <returns>The stored S3 object key</returns> <remarks> We leave the memo file present after reading in case a continued network loss means we don't exit the cmdlet through normal handling. The 'clean path' through the import cmdlets will delete the memo if no error occurs. </remarks> </member> <member name="M:Amazon.PowerShell.Cmdlets.EC2.EC2ImportCmdletsBase.WriteManifestMemoFile(System.String,System.String,System.String)"> <summary> Writes a memo-ization file to a subfolder of the user's appdata folder containing the S3 object key to the manifest we just failed to complete upload for. We'll read this file if the -Resume switch is set on next run. to save the user neededing to remember it or paste it manually into the new command. </summary> <param name="imageFilePath">The resolved path to the image file</param> <param name="bucketName">The name of the bucket containing the manifest</param> <param name="manifestFileKey">The S3 key of the manifest</param> <remarks> Although it's highly unlikely a user might upload two images with the same base name at the same time, we take a leaf out of Git's book and hash the path+filename of the image to append to the image name we use for the memo file -- this pretty much guarantees we correctly match the image and memo file in resume mode. </remarks> </member> <member name="M:Amazon.PowerShell.Cmdlets.EC2.EC2ImportCmdletsBase.CleanManifestMemoFile(System.String,System.String)"> <summary> Removes any memo-ization file for an image file on successful completion of processing. </summary> <param name="imageFilePath">The resolved path to the image file</param> <param name="bucketName">The name of the bucket containing the manifest</param> </member> <member name="M:Amazon.PowerShell.Cmdlets.EC2.EC2ImportCmdletsBase.HandleImportError(Amazon.EC2.Import.DiskImageImporter,Amazon.EC2.Import.DiskImageImporterException,System.Boolean)"> <summary> Constructs an appropriate error message depending on where the import error occurred. If rollback is not enabled (so we are leaving whatever artifacts were uploaded to S3 in place), we write a temporary memo file to a folder in the user's appdata that contains the S3 key of the manifest. If the cmdlet is restarted with the -Resume switch, we'll read the manifest key from there, analyze the manifest and continue uploaded. </summary> <param name="importHelper"></param> <param name="exc"></param> <param name="rollbackEnabled"></param> <returns></returns> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcAttributeCmdlet"> <summary> Modify an attribute on a VPC. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcAttributeCmdlet.VpcId"> <summary> <para> VPC ID to modify. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcAttributeCmdlet.EnableDnsSupport"> <summary> <para> Whether Dns is supported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcAttributeCmdlet.EnableDnsHostnames"> <summary> <para> Whether Dns hostnames are enabled. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcAttributeCmdlet.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.EC2.GetEC2ImageByNameCmdlet"> <summary> <para> Outputs a collection of one or more Amazon Machine Images using either a set of supplied service-pack independent 'logical' name pattern(s), or a set of custom name patterns. The set of service-pack independent logical names can be viewed using the -ShowFilters switch. </para> <para> If more than one name pattern is supplied (built-in or custom) then all available machine images that match the pattern are output. If only a single name pattern is supplied and it corresponds to one of the built-in service-pack independent names, then only the very latest machine image that matches is output. To see all versions of a machine image that correspond to a built-in name, use the -AllAvailable switch. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageByNameCmdlet.Name"> <summary> <para> A collection of one or more name patterns to use as filters to select an image. If this parameter is not specified, the set of built-in service-pack independent names are output. </para> <para> If the name supplied is recognized as one of the built-in service pack independent 'logical' names, it will be replaced internally by the corresponding pattern mapped by the logical name and used to query EC2 to find the latest available image corresponding to that name pattern. Using independent names means your script will continue to work even after AMIs are deprecated as new service packs are released. Names containing service pack/RTM designations can be deprecated as machine images are periodically refresh and eventually removed from the set of Amazon-published AMIs. </para> <para> If more than one value is supplied for this parameter, all machine images matching the name pattern are output, irrespective of whether the names supplied are from the built-in service-pack independent set or are custom name patterns of your own making. </para> <para> If a single value is supplied and it matches one of the built-in service-pack independent 'logical' names then only the very latest machine image corresponding to that name is output. Use the -AllAvailable switch to obtain the latest plus prior versions of the AMI. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageByNameCmdlet.ShowFilters"> <summary> If set, the cmdlet emits the actual name pattern used to filter the machine images. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageByNameCmdlet.AllAvailable"> <summary> <para> Amazon Web Services periodically refreshes machine images and 'deprecates' the prior versions. For a time it is possible for more than one image to correspond to a given logical filter. </para> <para> If this switch is specified and the name filter(s) supplied to the cmdlet are recognized as service pack independent 'logical' filters (i.e. the filter names shown if the -ShowFilters switch is supplied) then the cmdlet will emit all of the images corresponding to the filter. By default, the older images are suppressed and only the very latest image corresponding to the filter is output. </para> <para> If the supplied name filter(s) are not recognized (i.e. they are custom naming patterns of your own construction) then this switch is ignored and all matching images are returned. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceCmdlet"> <summary> Returns information about instances that you own. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results. Recently terminated instances might appear in the returned results.This interval is usually less than one hour. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceCmdlet.Instance"> <summary> Identifies the set of instances to return, specified either a collection of string instance ids, or a collection of RunningInstance objects. If not specified, all running instances are returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceCmdlet.Filter"> <summary> <para> A set of filters used to match system-defined properties and user-defined tags associated with the specified instances. </para> <para> Available filters: <ul> <li><c>architecture</c> - The instance architecture (<c>i386</c> | <c>x86_64</c>).</li> <li><c>association.public-ip</c> - The address of the Elastic IP address bound to the network interface.</li> <li><c>association.ip-owner-id</c> - The owner of the Elastic IP address associated with the network interface.</li> <li><c>association.allocation-id</c> - The allocation ID returned when you allocated the Elastic IP address for your network interface.</li> <li><c>association.association-id</c> - The association ID returned when the network interface was associated with an IP address.</li> <li><c>availability-zone</c> - The Availability Zone of the instance.</li> <li><c>block-device-mapping.attach-time</c> - The attach time for an Amazon EBS volume mapped to the instance.</li> <li><c>block-device-mapping.delete-on-termination</c> - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.</li> <li><c>block-device-mapping.device-name</c> - The device name for the Amazon EBS volume (for example, <c>/dev/sdh</c>).</li> <li><c>block-device-mapping.status</c> - The status for the Amazon EBS volume (<c>attaching</c> | <c>attached</c> | <c>detaching</c> | <c>detached</c>). </li> <li> <c>block-device-mapping.volume-id</c> - The volume ID of the Amazon EBS volume.</li> <li><c>client-token</c> - The idempotency token you provided when you launched the instance.</li> <li><c>dns-name</c> - The public DNS name of the instance.</li> <li><c>group-id</c> - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use <c>group-name</c> instead.</li> <li><c>group-name</c> - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use <c>group-id</c> instead.</li> <li><c>hypervisor</c> - The hypervisor type of the instance (<c>ovm</c> | <c>xen</c>).</li> <li><c>image-id</c> - The ID of the image used to launch the instance.</li> <li><c>instance-id</c> - The ID of the instance.</li> <li><c>instance-lifecycle</c> - Indicates whether this is a Spot Instance (<c>spot</c>).</li> <li><c>instance-state-code</c> - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).</li> <li><c>instance-state-name</c> - The state of the instance (<c>pending</c> | <c>running</c> | <c>shutting-down</c> | <c>terminated</c> | <c>stopping</c> | <c>stopped</c>).</li> <li><c>instance-type</c> - The type of instance (for example, <c>m1.small</c>).</li> <li><c>instance.group-id</c> - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use <c>instance.group-name</c> instead.</li> <li><c>instance.group-name</c> - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use <c>instance.group-id</c> instead.</li> <li><c>ip-address</c> - The public IP address of the instance.</li> <li><c>kernel-id</c> - The kernel ID.</li> <li><c>key-name</c> - The name of the key pair used when the instance was launched.</li> <li><c>launch-index</c> - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).</li> <li><c>launch-time</c> - The time when the instance was launched.</li> <li><c>monitoring-state</c> - Indicates whether monitoring is enabled for the instance (<c>disabled</c> | <c>enabled</c>).</li> <li><c>network-interface.description</c> - The description of the network interface.</li> <li><c>network-interface.subnet-id</c> - The ID of the subnet for the network interface.</li> <li><c>network-interface.vpc-id</c> - The ID of the VPC for the network interface.</li> <li><c>network-interface.network-interface-id</c> - The ID of the network interface.</li> <li><c>network-interface.owner-id</c> - The ID of the owner of the network interface.</li> <li><c>network-interface.availability-zone</c> - The Availability Zone for the network interface.</li> <li><c>network-interface.requester-id</c> - The requester ID for the network interface.</li> <li><c>network-interface.requester-managed</c> - Indicates whether the network interface is being managed by AWS.</li> <li><c>network-interface.status</c> - The status of the network interface (<c>available</c>) | <c>in-use</c>).</li> <li><c>network-interface.mac-address</c> - The MAC address of the network interface.</li> <li><c>network-interface-private-dns-name</c> - The private DNS name of the network interface.</li> <li><c>network-interface.source-destination-check</c> - Whether the network interface performs source/destination checking. A value of <c>true</c> means checking is enabled, and <c>false</c> means checking is disabled. The value must be <c>false</c> for the network interface to perform network address translation (NAT) in your VPC.</li> <li><c>network-interface.group-id</c> - The ID of a security group associated with the network interface.</li> <li><c>network-interface.group-name</c> - The name of a security group associated with the network interface.</li> <li><c>network-interface.attachment.attachment-id</c> - The ID of the interface attachment.</li> <li><c>network-interface.attachment.instance-id</c> - The ID of the instance to which the network interface is attached.</li> <li><c>network-interface.attachment.instance-owner-id</c> - The owner ID of the instance to which the network interface is attached.</li> <li><c>network-interface.addresses.private-ip-address</c> - The private IP address associated with the network interface.</li> <li><c>network-interface.attachment.device-index</c> - The device index to which the network interface is attached.</li> <li><c>network-interface.attachment.status</c> - The status of the attachment (<c>attaching</c> | <c>attached</c> | <c>detaching</c> | <c>detached</c>). </li> <li> <c>network-interface.attachment.attach-time</c> - The time that the network interface was attached to an instance.</li> <li><c>network-interface.attachment.delete-on-termination</c> - Specifies whether the attachment is deleted when an instance is terminated.</li> <li><c>network-interface.addresses.primary</c> - Specifies whether the IP address of the network interface is the primary private IP address.</li> <li><c>network-interface.addresses.association.public-ip</c> - The ID of the association of an Elastic IP address with a network interface.</li> <li><c>network-interface.addresses.association.ip-owner-id</c> - The owner ID of the private IP address associated with the network interface.</li> <li><c>owner-id</c> - The AWS account ID of the instance owner.</li> <li><c>placement-group-name</c> - The name of the placement group for the instance.</li> <li><c>platform</c> - The platform. Use <c>windows</c> if you have Windows instances; otherwise, leave blank.</li> <li><c>private-dns-name</c> - The private DNS name of the instance.</li> <li><c>private-ip-address</c> - The private IP address of the instance.</li> <li><c>product-code</c> - The product code associated with the AMI used to launch the instance.</li> <li><c>product-code.type</c> - The type of product code (<c>devpay</c> | <c>marketplace</c>). </li> <li> <c>ramdisk-id</c> - The RAM disk ID.</li> <li><c>reason</c> - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.</li> <li><c>requester-id</c> - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).</li> <li><c>reservation-id</c> - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.</li> <li><c>root-device-name</c> - The name of the root device for the instance (for example, <c>/dev/sda1</c>).</li> <li><c>root-device-type</c> - The type of root device that the instance uses (<c>ebs</c> | <c>instance-store</c>).</li> <li><c>source-dest-check</c> - Indicates whether the instance performs source/destination checking. A value of <c>true</c> means that checking is enabled, and <c>false</c> means checking is disabled. The value must be <c>false</c> for the instance to perform network address translation (NAT) in your VPC.</li> <li><c>spot-instance-request-id</c> - The ID of the Spot Instance request.</li> <li><c>state-reason-code</c> - The reason code for the state change.</li> <li><c>state-reason-message</c> - A message that describes the state change.</li> <li><c>subnet-id</c> - The ID of the subnet for the instance.</li> <li><c>tag</c>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource, where <c>tag</c>:<i>key</i> is the tag's key.</li> <li><c>tag-key</c> - The key of a tag assigned to the resource. This filter is independent of the <c>tag-value</c> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <c>tag</c>:<i>key</i>=<i>value</i> filter.</li> <li><c>tag-value</c> - The value of a tag assigned to the resource. This filter is independent of the <c>tag-key</c> filter.</li> <li><c>virtualization-type</c> - The virtualization type of the instance (<c>paravirtual</c> | <c>hvm</c>).</li> <li><c>vpc-id</c> - The ID of the VPC that the instance is running in.</li> </ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2PasswordDataCmdlet"> <summary> Retrieves the encrypted administrator password for the instances running Windows and optionally decrypts it. </summary> </member> <!-- Badly formed XML comment ignored for member "M:Amazon.PowerShell.Cmdlets.EC2.GetEC2PasswordDataCmdlet.DecryptViaPemDiscovery(System.String,Amazon.EC2.Model.GetPasswordDataResponse)" --> <member name="M:Amazon.PowerShell.Cmdlets.EC2.GetEC2PasswordDataCmdlet.DecryptViaPemFile(System.String,Amazon.EC2.Model.GetPasswordDataResponse)"> <summary> Loads the specified .pem file and uses it to decrypt the password data returned from the instance. </summary> <param name="pemFile">The full path to the .pem file to use</param> <param name="passwordDataResponse">Encrypted password data retrieved from the instance</param> <returns>The decrypted password</returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.EC2.GetEC2PasswordDataCmdlet.LookupAccountSettingsKey(System.String)"> <summary> Walks the credentials store to find the matching account settings for the specified access key </summary> <param name="accessKey"></param> <returns></returns> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PasswordDataCmdlet.InstanceId"> <summary> <para> The ID of the instance for which to get the password. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PasswordDataCmdlet.Decrypt"> <summary> If set, the instance password is decrypted and emitted to the pipeline as a string. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PasswordDataCmdlet.PemFile"> <summary> <para> The name of a .pem file containing the key materials corresponding to the keypair used to launch the instance. This will be used to decrypt the password data. </para> <para> If a .pem file is not specified and -Decrypt is set, the name of the keypair used to launch the instance will be retrieved from EC2 and an attempt made to load the keypair materials from the local store maintained by the AWS Toolkit for Visual Studio, if installed. </para> <remarks> If -PemFile is specified, then -Decrypt is assumed. </remarks> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet"> <summary> <para> <b>NOTE: This cmdlet has been deprecated and will be removed in a future release. Importing virtual machines and disk images to Amazon EC2 is now supported with the following cmdlets:</b> <ul> <li>Import-EC2Image</li> <li>Import-EC2Snapshot</li> <li>Get-EC2ImportImageTask</li> <li>Get-EC2ImportSnapshotTask</li> <li>Stop-EC2ImportTask</li> </ul> <br/> </para> <para> Uploads and converts a virtual machine image into a new Amazon EC2 instance or uploads the virtual image artifacts and generated import manifest, pending a request to begin import conversion at a later time. </para> <para> With its default settings the cmdlet uploads the virtual machine image file to Amazon S3 as a series of individual S3 objects and creates a manifest to control the subsequent image conversion yielding an EC2 instance. Once upload of the artifacts is complete the cmdlet sends a request to EC2 to begin the image conversion. This mode yields a ConversionTask object that can be used to monitor conversion progress using the Get-EC2ConversionTask cmdlet or stop the in-flight conversion with Stop-EC2ConversionTask. </para> <para> If run with the -UploadOnly switch the cmdlet creates the import manifest for the machine image and uploads it together with the series of parts representing the virtual machine image file into Amazon S3, but does not initiate the conversion. In this mode the S3 object key of the uploaded manifest is output. Import conversion of the artifacts to an EC2 instance can be started at a later time by re-executing the cmdlet with the -ManifestFileKey parameter and the name of the bucket holding the artifacts. </para> <para> Note that if the upload of the image file fails, any successfully upload content together with the import manifest is retained by default in the specified bucket. This enables the cmdlet to be re-executed in 'resume' mode with the -Resume parameter to continue upload of the image file. If this behavior is not desired and content uploaded to the bucket before the failure occurred should be deleted, use the -RollbackOnUploadFailure switch. </para> <para> For more information about importing machine images and disk volumes into Amazon EC2, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instances_of_your_vm.html">Importing and Exporting Instances</a> in the Amazon EC2 User Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.ImageFile"> <summary> Filename of the virtual machine disk image file to uploaded to Amazon S3 and imported into Amazon EC2. The cmdlet will perform the upload, manifest creation and presigned url generation and subsequent launch of the import conversion task returning a ConversionTask instance for progress monitoring to the pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.UploadOnly"> <summary> If set the cmdlet constructs the import manifest and uploads it plus the image file artifacts to Amazon S3 but does not request import conversion be started. The S3 key of the uploaded manifest file is output to the pipeline. This key can be used subsequently as the value for the -ManifestFileKey parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.FileFormat"> <summary> <para> The file format of the disk image. If a value is not specified the cmdlet will attempt to infer it from the extension of the image file. </para> <para> Valid values: VMDK, RAW, VHD. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.BucketName"> <summary> <para> The name of the Amazon S3 bucket that will, or does, contain the manifest and image file artifacts. If the bucket does not exist an attempt will be made to create it before the artifacts are uploaded. </para> <para> For bucket creation to succeed, the bucket name must not already exist (bucket names are global). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.KeyPrefix"> <summary> Optional prefix for the manifest and image file objects within the Amazon S3 bucket. The manifest and image file artifacts will be uploaded using keys consisting of this prefix and a generated GUID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.ManifestFileKey"> <summary> <para> If specified, the import process will be be started using a collection of manifests and image file artifacts that have been successfully uploaded previously to Amazon S3 (using the -UploadOnly switch). The collection of ConversionTask objects resulting from the operation are emitted to the pipeline. </para> <para> The parameter value is a collection of S3 object keys to existing manifest files. These keys are output when the cmdlet is run specifying the -UploadOnly switch or if an error occurrs when requesting import conversion be started (this allows you to re-start a conversion that failed due to a parameter error without uploading the image file(s) again. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.Description"> <summary> <para> An optional comment describing the image. This comment is returned with the associated conversion task during enumeration with the Get-EC2ConversionTask cmdlet. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.VolumeSize"> <summary> <para> The size of the Amazon EBS volume, in GiB (2^30 bytes), that will hold the converted image. If not specified it will be calculated from the size of the image file, rounded up to the nearest GiB. </para> <para> Note: images intended for use as Amazon EC2 boot volumes must be a minimum of 8GiB in size. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.UploadThreadCount"> <summary> Specifies the maximum number of threads to use to upload the image file parts to Amazon S3. Each thread will consume a minimum of 10MB of memory to handle the part data. Default: 10. Maximum: 30. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.Architecture"> <summary> <para> The architecture of the image. Using this option ensures that your image is imported as the expected instance type. </para> <para> <b>Constraints:</b> <list type="definition"><item><term>Allowed Values </term><description>i386, x86_64</description></item></list> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.AvailabilityZone"> <summary> The Availability Zone to launch the instance into. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.Group"> <summary> The security group within which the instances should be run. Determines the ingress firewall rules that are applied to the launched instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.InstanceInitiatedShutdownBehavior"> <summary> <para> Indicates whether an instance stops or terminates when you initiate shutdown from the within the instance (using the operating system command for system shutdown). </para> <para> <b>Constraints:</b> <list type="definition"><item><term>Allowed Values </term><description>stop, terminate</description></item></list> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.InstanceType"> <summary> The type of instance to be launched. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the Amazon Elastic Compute Cloud User Guide. For more information about the Linux instance types you can import, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html">Before You Get Started</a> in the Amazon Elastic Compute Cloud User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.Monitor"> <summary> Enables monitoring of the specified instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.Platform"> <summary> <para> The operating system of the instance. Default: Windows. </para> <para> <b>Constraints:</b> <list type="definition"><item><term>Allowed Values </term><description>Windows, Linux</description></item></list> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.PrivateIpAddress"> <summary> [EC2-VPC] The specific IP address within subnet to use for the instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.SubnetId"> <summary> [EC2-VPC] The ID of the subnet into which you're launching the instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.AdditionalInfo"> <summary> Reserved for internal use. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.Resume"> <summary> <para> If set, resumes a previous upload that was abandoned due to failure to upload one or more parts of the image file. Resuming an import applies only to the upload of the image artifacts. If Amazon EC2 returns an error from the resulting conversion you must start a new upload request to correct the issue. </para> <para> Note that if the cmdlet is run with the -RollbackOnUploadError switch set, resumption of the upload is not possible since the bucket contents will have been rolled back to delete the partially uploaded artifacts. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.RollbackOnUploadError"> <summary> If set and the image file fails to upload, the successfully uploaded parts and the manifest are removed automatically from S3 to avoid storage charges for potentially orphaned objects. By default the uploaded content is retained after error so that the cmdlet can be re-executed with the Resume parameter to resume upload of the failed content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2InstanceCmdlet.UrlExpiration"> <summary> <para> The validity period (in days) for the signed Amazon S3 URLs that allow Amazon EC2 to access the manifest. Default: 30 days. </para> <remarks> Note that for AWS regions requiring Signature Version 4 request signing, the maximum period is 7 days. Parameter values exceeding 7 are ignored for these regions. </remarks> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet"> <summary> <para> <b>NOTE: This cmdlet has been deprecated and will be removed in a future release. Importing virtual machines and disk images to Amazon EC2 is now supported with the following cmdlets:</b> <ul> <li>Import-EC2Image</li> <li>Import-EC2Snapshot</li> <li>Get-EC2ImportImageTask</li> <li>Get-EC2ImportSnapshotTask</li> <li>Stop-EC2ImportTask</li> </ul> <br/> </para> <para> Uploads and converts a virtual machine disk image, creating a new Amazon Elastic Block Store (EBS) volume or uploads the disk image artifacts and generated import manifest, pending a request to begin import conversion at a later time. </para> <para> With its default settings the cmdlet uploads the disk image file to Amazon S3 as a series of individual Amazon S3 objects and creates a manifest to control the subsequent image conversion yielding an EBS volume. Once upload of the artifacts is complete the cmdlet sends a request to EC2 to begin the volume conversion. This mode yields a ConversionTask object that can be used to monitor conversion progress using the Get-EC2ConversionTask cmdlet or stop the in-flight conversion with Stop-EC2ConversionTask. </para> <para> If run with the -UploadOnly switch the cmdlet creates the import manifest for the disk image and uploads it together with the series of parts representing the disk image file into Amazon S3, but does not initiate the conversion. In this mode the S3 object key of the uploaded manifest is output. Import conversion of the artifacts to an EBS volume can be started at a later time by re-executing the cmdlet with the -ManifestFileKey parameter and the name of the bucket holding the artifacts. </para> <para> Note that if the upload of the image file fails, any successfully upload content together with the import manifest is retained by default in the specified bucket. This enables the cmdlet to be re-executed in 'resume' mode with the -Resume parameter to continue upload of the image file. If this behavior is not desired and content uploaded to the bucket before the failure occurred should be deleted, use the -RollbackOnUploadFailure switch. </para> <para> For more information about importing machine images and disk volumes into Amazon EC2, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instances_of_your_vm.html">Importing and Exporting Instances</a> in the Amazon EC2 User Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.ImageFile"> <summary> Filename of the virtual machine disk image file to uploaded to Amazon S3 and imported into Amazon EC2. The cmdlet will perform the upload, manifest creation and presigned url generation and subsequent launch of the import conversion task, returning a ConversionTask instance for progress monitoring to the pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.UploadOnly"> <summary> If set the cmdlet constructs the import manifest and uploads it plus the image file to Amazon S3 but does not request import conversion be started. The S3 key of the uploaded manifest file is output. This key can be used subsequently as the value for the -ManifestFileKey parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.FileFormat"> <summary> <para> The file format of the disk image. If a value is not specified the cmdlet will attempt to infer it from the extension of the image file. </para> <para> Valid values: VMDK, RAW, VHD. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.BucketName"> <summary> <para> The name of the Amazon S3 bucket that will, or does, contain the manifest and image file artifacts. If the bucket does not exist an attempt will be made to create it before the artifacts are uploaded. </para> <para> For bucket creation to succeed, the bucket name must not already exist (bucket names are global). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.KeyPrefix"> <summary> Optional prefix for the manifest and image file objects within the Amazon S3 bucket. The manifest and image file artifacts will be uploaded using keys consisting of this prefix and a generated GUID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.ManifestFileKey"> <summary> <para> If specified, the import process will be be started using a collection of manifests and image file artifacts uploaded previously to Amazon S3 (using the -UploadOnly switch). The collection of ConversionTask objects resulting from the operation are emitted to the pipeline. </para> <para> The parameter value is a collection of S3 object keys to existing manifest files. These keys are output when the cmdlet is run specifying the -UploadOnly switch or if an error occurrs when requesting import conversion be started (this allows you to re-start a conversion that failed due to a parameter error without uploading the image file(s) again. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.Description"> <summary> An optional comment describing the image. This comment is returned with the associated conversion task during enumeration with the Get-EC2ConversionTask cmdlet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.VolumeSize"> <summary> <para> The size of the Amazon EBS volume, in GiB (2^30 bytes), that will hold the converted image. If not specified it will be calculated from the size of the image file, rounded up to the nearest GiB. </para> <para> Note: images intended for use as Amazon EC2 boot volumes must be a minimum of 8GiB in size. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.UploadThreadCount"> <summary> Specifies the maximum number of threads to use to upload the image file parts to Amazon S3. Each thread will consume a minimum of 10MB of memory to handle the part data. Default: 10. Maximum: 30. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.AvailabilityZone"> <summary> The Availability Zone for the resulting Amazon EBS volume. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.Resume"> <summary> <para> If set, resumes a previous upload that was abandoned due to failure to upload one or more parts of the image file. Resuming an import applies only to the upload of the image artifacts. If Amazon EC2 returns an error from the resulting conversion you must start a new upload request to correct the issue. </para> <para> Note that if the cmdlet is run with the -RollbackOnUploadError switch set, resumption of the upload is not possible since the bucket contents will have been rolled back to delete the partially uploaded artifacts. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.RollbackOnUploadError"> <summary> If set and the image file fails to upload, the successfully uploaded parts and the manifest are removed automatically from S3 to avoid storage charges for potentially orphaned objects. By default the uploaded content is retained after error so that the cmdlet can be re-executed with the Resume parameter to resume upload of the failed content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2VolumeCmdlet.UrlExpiration"> <summary> <para> The validity period (in days) for the signed Amazon S3 URLs that allow Amazon EC2 to access the manifest. Default: 30 days. </para> <remarks> Note that for AWS regions requiring Signature Version 4 request signing, the maximum period is 7 days. Parameter values exceeding 7 are ignored for these regions. </remarks> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet"> <summary> Launches a specified number of instances of an AMI for which you have permissions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.ImageId"> <summary> The ID of the AMI to launch. The set of available AMI IDs can be determined using the Get-EC2Image or Get-EC2ImageByName cmdlets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.AssociatePublicIp"> <summary> Indicates whether to assign a public IP address to an instance in a VPC. </summary> <remarks> <para>The public IP address is associated with a specific network interface. If set to true, the following rules apply:</para> <ol> <li> <p>Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.</p> </li> <li> <p>Can only be associated with a new network interface, not an existing one.</p> </li> </ol> <p> Default: If launching into a default subnet, the default value is <b>true</b>. If launching into a nondefault subnet, the default value is <b>false</b>. </p> </remarks> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.MinCount"> <summary> <para> The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances. </para> <para> Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see <a href="http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2">How many instances can I run in Amazon EC2</a> in the Amazon EC2 General FAQ. </para> <para> Default: 1. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.MaxCount"> <summary> <para> The maximum number of instances to launch. If you specify a maximum that is more instances than Amazon EC2 can launch in the target Availability Zone EC2 will try to launch the maximum number for the target Availability Zone, but launches no fewer than the minimum number. </para> <para> Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see <a href="http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2">How many instances can I run in Amazon EC2</a> in the Amazon EC2 General FAQ. </para> <para> Default: 1. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.KeyName"> <summary> The name of the key pair to use to connect to the instance using remote desktop or SSH. </summary> <remarks> <b>Important:</b> If you launch an instance without specifying a key pair, you can't connect to the instance. </remarks> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.SecurityGroup"> <summary> <para> The names of one or more security groups. Note that for a nondefault VPC, you must specify the security group by ID using the SecurityGroupIds parameter instead. For EC2-Classic or a default VPC, you can specify the security group by name or ID. </para> <para> Default: Amazon EC2 uses the default security group </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.SecurityGroupId"> <summary> <para> The IDs of one or more security groups. Note that for a nondefault VPC, you must specify the security group by ID using this parameter. For EC2-Classic or a default VPC, you can specify the security group by name or ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.UserData"> <summary> The base64-encoded MIME user data for the instances. If the -EncodeUserData switch is also set, the value for this parameter can be supplied as normal ASCII text and will be base64-encoded by the cmdlet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.UserDataFile"> <summary> The name of a file containing base64-encoded MIME user data for the instances. Using this parameter causes any value for the UserData parameter to be ignored. If the -EncodeUserData switch is also set, the contents of the file can be normal ASCII text and will be base64-encoded by the cmdlet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.EncodeUserData"> <summary> If set and the -UserData or -UserDataFile parameters are specified, the specified user data is base64 encoded prior to submitting to EC2. By default the user data is assumed to be encoded prior to being supplied to the cmdlet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.InstanceType"> <summary> <para> The instance type. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the Amazon Elastic Compute Cloud User Guide. </para> <para> Valid values: t2.micro | t2.small | t2.medium | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m1.small | m1.medium | m1.large | m1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c1.medium | c1.xlarge | cc2.8xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | cr1.8xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | hs1.8xlarge | hi1.4xlarge | t1.micro | g2.2xlarge | cg1.4xlarge </para> <para> Default: Amazon EC2 will use an m1.small instance if not specified. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.AvailabilityZone"> <summary> The Availability Zone for the instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.PlacementGroup"> <summary> The name of an existing placement group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.Tenancy"> <summary> <para> The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC. </para> <para> Valid Values: default | dedicated </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.KernelId"> <summary> <para> The ID of the kernel for the instance. </para> <para> <b>Important:</b> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">PV-GRUB</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.RamdiskId"> <summary> <para> The ID of the RAM disk. </para> <para> <b>Important:</b> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">PV-GRUB</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.BlockDeviceMapping"> <summary> The block device mapping for the instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a> in the Amazon Elastic Compute Cloud User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.Monitoring_Enabled"> <summary> Enables monitoring for the instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.SubnetId"> <summary> [EC2-VPC] The ID of the subnet to launch the instance into. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.DisableApiTermination"> <summary> If you enable this option, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you specify this option and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using Edit-EC2InstanceAttribute. Alternatively, if you set -InstanceInitiatedShutdownBehavior to 'terminate', you can terminate the instance by running the shutdown command from the instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.InstanceInitiatedShutdownBehavior"> <summary> <para> Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). </para> <para> Valid values: stop | terminate. Default: stop. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.PrivateIpAddress"> <summary> [EC2-VPC] The primary private IP address. You must specify a value from the IP address range of the subnet. If not specified EC2 will assign an IP address from the IP address range of the subnet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.ClientToken"> <summary> <para> Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a> in the Amazon Elastic Compute Cloud User Guide. </para> <para> Constraints: Maximum 64 ASCII characters </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.NetworkInterface"> <summary> <para> A set of one or more existing network interfaces to attach to the instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.EbsOptimized"> <summary> <para> Enables Amazon EBS optimization for the instance. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This option isn't available with all instance types. Additional usage charge apply when using this option. </para> <para> Default: false (disabled) </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.InstanceProfile_Arn"> <summary> The ARN of an IAM instance profile to associate with the instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.InstanceProfile_Name"> <summary> The name of an IAM instance profile to associate with the instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.AdditionalInfo"> <summary> Reserved for internal use. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceCmdlet.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.EC2.StopEC2InstanceCmdlet"> <summary> Stops or terminates an instance. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Stopping an instance that uses an instance store as its root device returns an error. The Terminate operation is idempotent; if you terminate an instance more than once, each call will succeed. Terminated instances will remain visible after termination (approximately one hour). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2InstanceCmdlet.Instance"> <summary> Identifies the set of instances to stop or terminate. Accepts a string instance ID or a collection of RunningInstance or Reservation objects. If a Reservation object is supplied, all of the instances in the reservation are processed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2InstanceCmdlet.ForceStop"> <summary> Forces the instance to stop. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. Note: this option is not compatible with the Terminate switch. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2InstanceCmdlet.Terminate"> <summary> Signals that the command should Terminate the instance, instead of just stopping it. If this option is specified, the cmdlet prompts for user confirmation unless the -Force switch is specified. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2InstanceCmdlet.Force"> <summary> <para> If -Terminate is specified, the instance(s) specified are terminated with no further confirmation. </para> <para> If this is switch is not specified, the instance(s) are simply stopped and are thus available for restart. No confirmation is required to stop an instance. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.AddEC2ClassicLinkVpcCmdlet"> <summary> Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the <code>running</code> state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. <para> After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. </para><para> Linking your instance to a VPC is sometimes referred to as <i>attaching</i> your instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2ClassicLinkVpcCmdlet.Group"> <summary> <para> <para>The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2ClassicLinkVpcCmdlet.InstanceId"> <summary> <para> <para>The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2ClassicLinkVpcCmdlet.VpcId"> <summary> <para> <para>The ID of a ClassicLink-enabled VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2ClassicLinkVpcCmdlet.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.EC2.AddEC2InternetGatewayCmdlet"> <summary> Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2InternetGatewayCmdlet.InternetGatewayId"> <summary> <para> <para>The ID of the Internet gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2InternetGatewayCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2InternetGatewayCmdlet.PassThru"> <summary> Returns the value passed to the VpcId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2InternetGatewayCmdlet.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.EC2.AddEC2NetworkInterfaceCmdlet"> <summary> Attaches a network interface to an instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2NetworkInterfaceCmdlet.DeviceIndex"> <summary> <para> <para>The index of the device for the network interface attachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2NetworkInterfaceCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2NetworkInterfaceCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2NetworkInterfaceCmdlet.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.EC2.AddEC2VolumeCmdlet"> <summary> Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. <para> Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para><para> For a list of supported device names, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching an EBS Volume to an Instance</a>. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 Instance Store</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para><para> If a volume has an AWS Marketplace product code: </para><ul><li>The volume can be attached only to a stopped instance.</li><li>AWS Marketplace product codes are copied from the volume to the instance.</li><li>You must be subscribed to the product.</li><li>The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.</li></ul><para> For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000">Introducing AWS Marketplace</a>. </para><para> For more information about EBS volumes, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2VolumeCmdlet.Device"> <summary> <para> <para>The device name to expose to the instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2VolumeCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2VolumeCmdlet.VolumeId"> <summary> <para> <para>The ID of the EBS volume. The volume and instance must be within the same Availability Zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2VolumeCmdlet.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.EC2.AddEC2VpnGatewayCmdlet"> <summary> Attaches a virtual private gateway to a VPC. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2VpnGatewayCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2VpnGatewayCmdlet.VpnGatewayId"> <summary> <para> <para>The ID of the virtual private gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.AddEC2VpnGatewayCmdlet.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.EC2.ApproveEC2VpcPeeringConnectionCmdlet"> <summary> Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use the <code>DescribeVpcPeeringConnections</code> request to view your outstanding VPC peering connection requests. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ApproveEC2VpcPeeringConnectionCmdlet.VpcPeeringConnectionId"> <summary> <para> <para>The ID of the VPC peering connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ApproveEC2VpcPeeringConnectionCmdlet.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.EC2.ConfirmEC2ProductInstanceCmdlet"> <summary> Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ConfirmEC2ProductInstanceCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ConfirmEC2ProductInstanceCmdlet.ProductCode"> <summary> <para> <para>The product code. This must be a product code that you own.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ConfirmEC2ProductInstanceCmdlet.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.EC2.CopyEC2ImageCmdlet"> <summary> Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copying AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2ImageCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2ImageCmdlet.Description"> <summary> <para> <para>A description for the new AMI in the destination region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2ImageCmdlet.Name"> <summary> <para> <para>The name of the new AMI in the destination region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2ImageCmdlet.SourceImageId"> <summary> <para> <para>The ID of the AMI to copy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2ImageCmdlet.SourceRegion"> <summary> <para> <para>The name of the region that contains the AMI to copy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2ImageCmdlet.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.EC2.CopyEC2SnapshotCmdlet"> <summary> Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to. <para> Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the <code>Encrypted</code> flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the <code>KmsKeyId</code> parameter. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html">Copying an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2SnapshotCmdlet.Description"> <summary> <para> <para>A description for the EBS snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2SnapshotCmdlet.DestinationRegion"> <summary> <para> <para>The destination region to use in the <code>PresignedUrl</code> parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a <code>PresignedUrl</code> parameter, where it is required.</para><note><para><code>CopySnapshot</code> sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as <code>ec2.us-east-1.amazonaws.com</code> (in the AWS CLI, this is specified with the <code>--region</code> parameter or the default region in your AWS configuration file).</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2SnapshotCmdlet.Encrypted"> <summary> <para> <para>Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with <code>KmsKeyId</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2SnapshotCmdlet.KmsKeyId"> <summary> <para> <para>The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the <code>arn:aws:kms</code> namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the <code>key</code> namespace, and then the CMK ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>. The specified CMK must exist in the region that the snapshot is being copied to. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2SnapshotCmdlet.SourceRegion"> <summary> <para> <para>The ID of the region that contains the snapshot to be copied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2SnapshotCmdlet.SourceSnapshotId"> <summary> <para> <para>The ID of the EBS snapshot to copy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.CopyEC2SnapshotCmdlet.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.EC2.DenyEC2VpcPeeringConnectionCmdlet"> <summary> Rejects a VPC peering connection request. The VPC peering connection must be in the <code>pending-acceptance</code> state. Use the <a>DescribeVpcPeeringConnections</a> request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use <a>DeleteVpcPeeringConnection</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DenyEC2VpcPeeringConnectionCmdlet.VpcPeeringConnectionId"> <summary> <para> <para>The ID of the VPC peering connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DenyEC2VpcPeeringConnectionCmdlet.PassThru"> <summary> Returns the value passed to the VpcPeeringConnectionId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DenyEC2VpcPeeringConnectionCmdlet.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.EC2.DisableEC2VgwRoutePropagationCmdlet"> <summary> Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DisableEC2VgwRoutePropagationCmdlet.GatewayId"> <summary> <para> <para>The ID of the virtual private gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DisableEC2VgwRoutePropagationCmdlet.RouteTableId"> <summary> <para> <para>The ID of the route table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DisableEC2VgwRoutePropagationCmdlet.PassThru"> <summary> Returns the value passed to the RouteTableId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DisableEC2VgwRoutePropagationCmdlet.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.EC2.DisableEC2VpcClassicLinkCmdlet"> <summary> Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DisableEC2VpcClassicLinkCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DisableEC2VpcClassicLinkCmdlet.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.EC2.DismountEC2ClassicLinkVpcCmdlet"> <summary> Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2ClassicLinkVpcCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance to unlink from the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2ClassicLinkVpcCmdlet.VpcId"> <summary> <para> <para> The ID of the VPC to which the instance is linked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2ClassicLinkVpcCmdlet.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.EC2.DismountEC2InternetGatewayCmdlet"> <summary> Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2InternetGatewayCmdlet.InternetGatewayId"> <summary> <para> <para>The ID of the Internet gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2InternetGatewayCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2InternetGatewayCmdlet.PassThru"> <summary> Returns the value passed to the VpcId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2InternetGatewayCmdlet.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.EC2.DismountEC2NetworkInterfaceCmdlet"> <summary> Detaches a network interface from an instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2NetworkInterfaceCmdlet.AttachmentId"> <summary> <para> <para>The ID of the attachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2NetworkInterfaceCmdlet.ForceDismount"> <summary> <para> <para>Specifies whether to force a detachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2NetworkInterfaceCmdlet.PassThru"> <summary> Returns the value passed to the AttachmentId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2NetworkInterfaceCmdlet.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.EC2.DismountEC2VolumeCmdlet"> <summary> Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching. <para> If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. </para><para> When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html">Detaching an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VolumeCmdlet.Device"> <summary> <para> <para>The device name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VolumeCmdlet.ForceDismount"> <summary> <para> <para>Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VolumeCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VolumeCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VolumeCmdlet.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.EC2.DismountEC2VpnGatewayCmdlet"> <summary> Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). <para> You must wait for the attachment's state to switch to <code>detached</code> before you can delete the VPC or attach a different VPC to the virtual private gateway. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VpnGatewayCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VpnGatewayCmdlet.VpnGatewayId"> <summary> <para> <para>The ID of the virtual private gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VpnGatewayCmdlet.PassThru"> <summary> Returns the value passed to the VpcId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.DismountEC2VpnGatewayCmdlet.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.EC2.EditEC2ImageAttributeCmdlet"> <summary> Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. <note><para> AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.LaunchPermission_Add"> <summary> <para> <para>The AWS account ID to add to the list of launch permissions for the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.Attribute"> <summary> <para> <para>The name of the attribute to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.Description"> <summary> <para> <para>A description for the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.ImageId"> <summary> <para> <para>The ID of the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.OperationType"> <summary> <para> <para>The operation type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.ProductCode"> <summary> <para> <para>One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the <code>productCodes</code> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.LaunchPermission_Remove"> <summary> <para> <para>The AWS account ID to remove from the list of launch permissions for the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.UserGroup"> <summary> <para> <para>One or more user groups. This is only valid when modifying the <code>launchPermission</code> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.UserId"> <summary> <para> <para>One or more AWS account IDs. This is only valid when modifying the <code>launchPermission</code> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.Value"> <summary> <para> <para>The value of the attribute being modified. This is only valid when modifying the <code>description</code> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.PassThru"> <summary> Returns the value passed to the ImageId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ImageAttributeCmdlet.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.EC2.EditEC2InstanceAttributeCmdlet"> <summary> Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. <para> To modify some attributes, the instance must be stopped. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modifying Attributes of a Stopped Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.Attribute"> <summary> <para> <para>The name of the attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.BlockDeviceMapping"> <summary> <para> <para>Modifies the <code>DeleteOnTermination</code> attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for <code>DeleteOnTermination</code>, the default is <code>true</code> and the volume is deleted when the instance is terminated.</para><para>To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM">Updating the Block Device Mapping when Launching an Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.DisableApiTermination"> <summary> <para> <para>If the value is <code>true</code>, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.EbsOptimized"> <summary> <para> <para>Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.Group"> <summary> <para> <para>[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.InstanceInitiatedShutdownBehavior"> <summary> <para> <para>Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.InstanceType"> <summary> <para> <para>Changes the instance type to the specified value. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a>. If the instance type is not valid, the error returned is <code>InvalidInstanceAttributeValue</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.Kernel"> <summary> <para> <para>Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">PV-GRUB</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.Ramdisk"> <summary> <para> <para>Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">PV-GRUB</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.SourceDestCheck"> <summary> <para> <para>Specifies whether source/destination checking is enabled. A value of <code>true</code> means that checking is enabled, and <code>false</code> means checking is disabled. This value must be <code>false</code> for a NAT instance to perform NAT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.SriovNetSupport"> <summary> <para> <para>Set to <code>simple</code> to enable enhanced networking for the instance.</para><para>There is no way to disable enhanced networking at this time.</para><para>This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.UserData"> <summary> <para> <para>Changes the instance's user data to the specified value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.Value"> <summary> <para> <para>A new value for the attribute. Use only with the <code>kernel</code>, <code>ramdisk</code>, <code>userData</code>, <code>disableApiTermination</code>, or <code>instanceInitiatedShutdownBehavior</code> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2InstanceAttributeCmdlet.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.EC2.EditEC2NetworkInterfaceAttributeCmdlet"> <summary> Modifies the specified network interface attribute. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2NetworkInterfaceAttributeCmdlet.Attachment_AttachmentId"> <summary> <para> <para>The ID of the network interface attachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2NetworkInterfaceAttributeCmdlet.Attachment_DeleteOnTermination"> <summary> <para> <para>Indicates whether the network interface is deleted when the instance is terminated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2NetworkInterfaceAttributeCmdlet.Description"> <summary> <para> <para>A description for the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2NetworkInterfaceAttributeCmdlet.Group"> <summary> <para> <para>Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2NetworkInterfaceAttributeCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2NetworkInterfaceAttributeCmdlet.SourceDestCheck"> <summary> <para> <para>Indicates whether source/destination checking is enabled. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2NetworkInterfaceAttributeCmdlet.PassThru"> <summary> Returns the value passed to the NetworkInterfaceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2NetworkInterfaceAttributeCmdlet.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.EC2.EditEC2ReservedInstanceCmdlet"> <summary> Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ReservedInstanceCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ReservedInstanceCmdlet.ReservedInstancesId"> <summary> <para> <para>The IDs of the Reserved Instances to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ReservedInstanceCmdlet.TargetConfiguration"> <summary> <para> <para>The configuration settings for the Reserved Instances to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2ReservedInstanceCmdlet.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.EC2.EditEC2SnapshotAttributeCmdlet"> <summary> Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para><note><para> Snapshots with AWS Marketplace product codes cannot be made public. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.CreateVolumePermission_Add"> <summary> <para> <para>Adds a specific AWS account ID or group to a volume's list of create volume permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.Attribute"> <summary> <para> <para>The snapshot attribute to modify.</para><note><para>Only volume creation permissions may be modified at the customer level.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.GroupName"> <summary> <para> <para>The group to modify for the snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.OperationType"> <summary> <para> <para>The type of operation to perform to the attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.CreateVolumePermission_Remove"> <summary> <para> <para>Removes a specific AWS account ID or group from a volume's list of create volume permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.SnapshotId"> <summary> <para> <para>The ID of the snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.UserId"> <summary> <para> <para>The account ID to modify for the snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.PassThru"> <summary> Returns the value passed to the SnapshotId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SnapshotAttributeCmdlet.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.EC2.EditEC2SpotFleetRequestCmdlet"> <summary> Modifies the specified Spot fleet request. <para> While the Spot fleet request is being modified, it is in the <code>modifying</code> state. </para><para> To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is <code>lowestPrice</code>, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is <code>diversified</code>, the Spot fleet distributes the instances across the Spot pools. </para><para> To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>diversified</code>, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SpotFleetRequestCmdlet.ExcessCapacityTerminationPolicy"> <summary> <para> <para>Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SpotFleetRequestCmdlet.TargetCapacity"> <summary> <para> <para>The size of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SpotFleetRequestCmdlet.SpotFleetRequestId"> <summary> <para> <para>The ID of the Spot fleet request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SpotFleetRequestCmdlet.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.EC2.EditEC2SubnetAttributeCmdlet"> <summary> Modifies a subnet attribute. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SubnetAttributeCmdlet.MapPublicIpOnLaunch"> <summary> <para> <para>Specify <code>true</code> to indicate that instances launched into the specified subnet should be assigned public IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SubnetAttributeCmdlet.SubnetId"> <summary> <para> <para>The ID of the subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2SubnetAttributeCmdlet.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.EC2.EditEC2VolumeAttributeCmdlet"> <summary> Modifies a volume attribute. <para> By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. </para><para> You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VolumeAttributeCmdlet.AutoEnableIO"> <summary> <para> <para>Indicates whether the volume should be auto-enabled for I/O operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VolumeAttributeCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VolumeAttributeCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VolumeAttributeCmdlet.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.EC2.EditEC2VpcEndpointCmdlet"> <summary> Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcEndpointCmdlet.AddRouteTableId"> <summary> <para> <para>One or more route tables IDs to associate with the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcEndpointCmdlet.PolicyDocument"> <summary> <para> <para>A policy document to attach to the endpoint. The policy must be in valid JSON format. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcEndpointCmdlet.RemoveRouteTableId"> <summary> <para> <para>One or more route table IDs to disassociate from the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcEndpointCmdlet.ResetPolicy"> <summary> <para> <para>Specify <code>true</code> to reset the policy document to the default policy. The default policy allows access to the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcEndpointCmdlet.VpcEndpointId"> <summary> <para> <para>The ID of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcEndpointCmdlet.PassThru"> <summary> Returns the value passed to the VpcEndpointId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EditEC2VpcEndpointCmdlet.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.EC2.EnableEC2VgwRoutePropagationCmdlet"> <summary> Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VgwRoutePropagationCmdlet.GatewayId"> <summary> <para> <para>The ID of the virtual private gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VgwRoutePropagationCmdlet.RouteTableId"> <summary> <para> <para>The ID of the route table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VgwRoutePropagationCmdlet.PassThru"> <summary> Returns the value passed to the RouteTableId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VgwRoutePropagationCmdlet.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.EC2.EnableEC2VolumeIOCmdlet"> <summary> Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VolumeIOCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VolumeIOCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VolumeIOCmdlet.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.EC2.EnableEC2VpcClassicLinkCmdlet"> <summary> Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local routes for VPCs in the <code>10.0.0.0/16</code> and <code>10.1.0.0/16</code> IP address ranges. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the Amazon Elastic Compute Cloud User Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VpcClassicLinkCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.EnableEC2VpcClassicLinkCmdlet.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.EC2.GetEC2AccountAttributesCmdlet"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul><li><para><code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para></li><li><para><code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para></li><li><para><code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para></li><li><para><code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para></li><li><para><code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para></li><li><para><code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2AccountAttributesCmdlet.AttributeName"> <summary> <para> <para>One or more account attribute names.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2AddressCmdlet"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2AddressCmdlet.AllocationId"> <summary> <para> <para>[EC2-VPC] One or more allocation IDs.</para><para>Default: Describes all your Elastic IP addresses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2AddressCmdlet.Filter"> <summary> <para> <para>One or more filters. Filter names and values are case-sensitive.</para><ul><li><para><code>allocation-id</code> - [EC2-VPC] The allocation ID for the address.</para></li><li><para><code>association-id</code> - [EC2-VPC] The association ID for the address.</para></li><li><para><code>domain</code> - Indicates whether the address is for use in EC2-Classic (<code>standard</code>) or in a VPC (<code>vpc</code>).</para></li><li><para><code>instance-id</code> - The ID of the instance the address is associated with, if any.</para></li><li><para><code>network-interface-id</code> - [EC2-VPC] The ID of the network interface that the address is associated with, if any.</para></li><li><para><code>network-interface-owner-id</code> - The AWS account ID of the owner.</para></li><li><para><code>private-ip-address</code> - [EC2-VPC] The private IP address associated with the Elastic IP address.</para></li><li><para><code>public-ip</code> - The Elastic IP address.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2AddressCmdlet.PublicIp"> <summary> <para> <para>[EC2-Classic] One or more Elastic IP addresses.</para><para>Default: Describes all your Elastic IP addresses.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2AvailabilityZoneCmdlet"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2AvailabilityZoneCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>message</code> - Information about the Availability Zone.</para></li><li><para><code>region-name</code> - The name of the region for the Availability Zone (for example, <code>us-east-1</code>).</para></li><li><para><code>state</code> - The state of the Availability Zone (<code>available</code> | <code>information</code> | <code>impaired</code> | <code>unavailable</code>).</para></li><li><para><code>zone-name</code> - The name of the Availability Zone (for example, <code>us-east-1a</code>).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2AvailabilityZoneCmdlet.ZoneName"> <summary> <para> <para>The names of one or more Availability Zones.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2BundleTaskCmdlet"> <summary> Describes one or more of your bundling tasks. <note><para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2BundleTaskCmdlet.BundleId"> <summary> <para> <para>One or more bundle task IDs.</para><para>Default: Describes all your bundle tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2BundleTaskCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>bundle-id</code> - The ID of the bundle task.</para></li><li><para><code>error-code</code> - If the task failed, the error code returned.</para></li><li><para><code>error-message</code> - If the task failed, the error message returned.</para></li><li><para><code>instance-id</code> - The ID of the instance.</para></li><li><para><code>progress</code> - The level of task completion, as a percentage (for example, 20%).</para></li><li><para><code>s3-bucket</code> - The Amazon S3 bucket to store the AMI.</para></li><li><para><code>s3-prefix</code> - The beginning of the AMI name.</para></li><li><para><code>start-time</code> - The time the task started (for example, 2013-09-15T17:15:20.000Z).</para></li><li><para><code>state</code> - The state of the task (<code>pending</code> | <code>waiting-for-shutdown</code> | <code>bundling</code> | <code>storing</code> | <code>cancelling</code> | <code>complete</code> | <code>failed</code>).</para></li><li><para><code>update-time</code> - The time of the most recent update for the task.</para></li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ClassicLinkInstanceCmdlet"> <summary> Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ClassicLinkInstanceCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>group-id</code> - The ID of a VPC security group that's associated with the instance.</para></li><li><para><code>instance-id</code> - The ID of the instance.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>vpc-id</code> - The ID of the VPC that the instance is linked to.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ClassicLinkInstanceCmdlet.InstanceId"> <summary> <para> <para>One or more instance IDs. Must be instances linked to a VPC through ClassicLink.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ClassicLinkInstanceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.</para><para>Constraint: If the value is greater than 1000, we return only 1000 items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ClassicLinkInstanceCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ConsoleOutputCmdlet"> <summary> Gets the console output for the specified instance. <para> Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface. </para><para> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post. </para><para> For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it. </para><para> For Windows instances, the instance console output includes output from the EC2Config service. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ConsoleOutputCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2CustomerGatewayCmdlet"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2CustomerGatewayCmdlet.CustomerGatewayId"> <summary> <para> <para>One or more customer gateway IDs.</para><para>Default: Describes all your customer gateways.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2CustomerGatewayCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>bgp-asn</code> - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).</para></li><li><para><code>customer-gateway-id</code> - The ID of the customer gateway.</para></li><li><para><code>ip-address</code> - The IP address of the customer gateway's Internet-routable external interface.</para></li><li><para><code>state</code> - The state of the customer gateway (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</para></li><li><para><code>type</code> - The type of customer gateway. Currently, the only supported type is <code>ipsec.1</code>.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2DhcpOptionCmdlet"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2DhcpOptionCmdlet.DhcpOptionsId"> <summary> <para> <para>The IDs of one or more DHCP options sets.</para><para>Default: Describes all your DHCP options sets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2DhcpOptionCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>dhcp-options-id</code> - The ID of a set of DHCP options.</para></li><li><para><code>key</code> - The key for one of the options (for example, <code>domain-name</code>).</para></li><li><para><code>value</code> - The value for one of the options.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ExportTasksCmdlet"> <summary> Describes one or more of your export tasks. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ExportTasksCmdlet.ExportTaskId"> <summary> <para> <para>One or more export task IDs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2FlowLogsCmdlet"> <summary> Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2FlowLogsCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>deliver-log-status</code> - The status of the logs delivery (<code>SUCCESS</code> | <code>FAILED</code>).</para></li><li><para><code>flow-log-id</code> - The ID of the flow log.</para></li><li><para><code>log-group-name</code> - The name of the log group.</para></li><li><para><code>resource-id</code> - The ID of the VPC, subnet, or network interface.</para></li><li><para><code>traffic-type</code> - The type of traffic (<code>ACCEPT</code> | <code>REJECT</code> | <code>ALL</code>)</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2FlowLogsCmdlet.FlowLogId"> <summary> <para> <para>One or more flow log IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2FlowLogsCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2FlowLogsCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageCmdlet"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note><para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageCmdlet.ExecutableUser"> <summary> <para> <para>Scopes the images by users with explicit launch permissions. Specify an AWS account ID, <code>self</code> (the sender of the request), or <code>all</code> (public AMIs).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>architecture</code> - The image architecture (<code>i386</code> | <code>x86_64</code>).</para></li><li><para><code>block-device-mapping.delete-on-termination</code> - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.</para></li><li><para><code>block-device-mapping.device-name</code> - The device name for the EBS volume (for example, <code>/dev/sdh</code>).</para></li><li><para><code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the EBS volume.</para></li><li><para><code>block-device-mapping.volume-size</code> - The volume size of the EBS volume, in GiB.</para></li><li><para><code>block-device-mapping.volume-type</code> - The volume type of the EBS volume (<code>gp2</code> | <code>standard</code> | <code>io1</code>).</para></li><li><para><code>description</code> - The description of the image (provided during image creation).</para></li><li><para><code>hypervisor</code> - The hypervisor type (<code>ovm</code> | <code>xen</code>).</para></li><li><para><code>image-id</code> - The ID of the image.</para></li><li><para><code>image-type</code> - The image type (<code>machine</code> | <code>kernel</code> | <code>ramdisk</code>).</para></li><li><para><code>is-public</code> - A Boolean that indicates whether the image is public.</para></li><li><para><code>kernel-id</code> - The kernel ID.</para></li><li><para><code>manifest-location</code> - The location of the image manifest.</para></li><li><para><code>name</code> - The name of the AMI (provided during image creation).</para></li><li><para><code>owner-alias</code> - The AWS account alias (for example, <code>amazon</code>).</para></li><li><para><code>owner-id</code> - The AWS account ID of the image owner.</para></li><li><para><code>platform</code> - The platform. To only list Windows-based AMIs, use <code>windows</code>.</para></li><li><para><code>product-code</code> - The product code.</para></li><li><para><code>product-code.type</code> - The type of the product code (<code>devpay</code> | <code>marketplace</code>).</para></li><li><para><code>ramdisk-id</code> - The RAM disk ID.</para></li><li><para><code>root-device-name</code> - The name of the root device volume (for example, <code>/dev/sda1</code>).</para></li><li><para><code>root-device-type</code> - The type of the root device volume (<code>ebs</code> | <code>instance-store</code>).</para></li><li><para><code>state</code> - The state of the image (<code>available</code> | <code>pending</code> | <code>failed</code>).</para></li><li><para><code>state-reason-code</code> - The reason code for the state change.</para></li><li><para><code>state-reason-message</code> - The message for the state change.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>virtualization-type</code> - The virtualization type (<code>paravirtual</code> | <code>hvm</code>).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageCmdlet.ImageId"> <summary> <para> <para>One or more image IDs.</para><para>Default: Describes all images available to you.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageCmdlet.Owner"> <summary> <para> <para>Filters the images by the owner. Specify an AWS account ID, <code>amazon</code> (owner is Amazon), <code>aws-marketplace</code> (owner is AWS Marketplace), <code>self</code> (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageAttributeCmdlet"> <summary> Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageAttributeCmdlet.Attribute"> <summary> <para> <para>The AMI attribute.</para><para><b>Note</b>: Depending on your account privileges, the <code>blockDeviceMapping</code> attribute may return a <code>Client.AuthFailure</code> error. If this happens, use <a>DescribeImages</a> to get information about the block device mapping for the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImageAttributeCmdlet.ImageId"> <summary> <para> <para>The ID of the AMI.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportImageTaskCmdlet"> <summary> Displays details about an import virtual machine or import snapshot tasks that are already created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportImageTaskCmdlet.Filter"> <summary> <para> <para>One or more filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportImageTaskCmdlet.ImportTaskId"> <summary> <para> <para>A list of import image task IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportImageTaskCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportImageTaskCmdlet.NextToken"> <summary> <para> <para>A token that indicates the next page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportSnapshotTaskCmdlet"> <summary> Describes your import snapshot tasks. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportSnapshotTaskCmdlet.Filter"> <summary> <para> <para>One or more filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportSnapshotTaskCmdlet.ImportTaskId"> <summary> <para> <para>A list of import snapshot task IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportSnapshotTaskCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ImportSnapshotTaskCmdlet.NextToken"> <summary> <para> <para>A token that indicates the next page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceAttributeCmdlet"> <summary> Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> | <code>userData</code> | <code>disableApiTermination</code> | <code>instanceInitiatedShutdownBehavior</code> | <code>rootDeviceName</code> | <code>blockDeviceMapping</code> | <code>productCodes</code> | <code>sourceDestCheck</code> | <code>groupSet</code> | <code>ebsOptimized</code> | <code>sriovNetSupport</code> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceAttributeCmdlet.Attribute"> <summary> <para> <para>The instance attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceAttributeCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceStatusCmdlet"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para><ul><li><para><b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para></li><li><para><b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para></li><li><para><b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceStatusCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>availability-zone</code> - The Availability Zone of the instance.</para></li><li><para><code>event.code</code> - The code for the scheduled event (<code>instance-reboot</code> | <code>system-reboot</code> | <code>system-maintenance</code> | <code>instance-retirement</code> | <code>instance-stop</code>).</para></li><li><para><code>event.description</code> - A description of the event.</para></li><li><para><code>event.not-after</code> - The latest end time for the scheduled event (for example, <code>2014-09-15T17:15:20.000Z</code>).</para></li><li><para><code>event.not-before</code> - The earliest start time for the scheduled event (for example, <code>2014-09-15T17:15:20.000Z</code>).</para></li><li><para><code>instance-state-code</code> - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).</para></li><li><para><code>instance-state-name</code> - The state of the instance (<code>pending</code> | <code>running</code> | <code>shutting-down</code> | <code>terminated</code> | <code>stopping</code> | <code>stopped</code>).</para></li><li><para><code>instance-status.reachability</code> - Filters on instance status where the name is <code>reachability</code> (<code>passed</code> | <code>failed</code> | <code>initializing</code> | <code>insufficient-data</code>).</para></li><li><para><code>instance-status.status</code> - The status of the instance (<code>ok</code> | <code>impaired</code> | <code>initializing</code> | <code>insufficient-data</code> | <code>not-applicable</code>).</para></li><li><para><code>system-status.reachability</code> - Filters on system status where the name is <code>reachability</code> (<code>passed</code> | <code>failed</code> | <code>initializing</code> | <code>insufficient-data</code>).</para></li><li><para><code>system-status.status</code> - The system status of the instance (<code>ok</code> | <code>impaired</code> | <code>initializing</code> | <code>insufficient-data</code> | <code>not-applicable</code>).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceStatusCmdlet.IncludeAllInstance"> <summary> <para> <para>When <code>true</code>, includes the health status for all instances. When <code>false</code>, includes the health status for running instances only.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceStatusCmdlet.InstanceId"> <summary> <para> <para>One or more instance IDs.</para><para>Default: Describes all your instances.</para><para>Constraints: Maximum 100 explicitly specified instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceStatusCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InstanceStatusCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2InternetGatewayCmdlet"> <summary> Describes one or more of your Internet gateways. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InternetGatewayCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>available</code>). Present only if a VPC is attached.</para></li><li><para><code>attachment.vpc-id</code> - The ID of an attached VPC.</para></li><li><para><code>internet-gateway-id</code> - The ID of the Internet gateway.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2InternetGatewayCmdlet.InternetGatewayId"> <summary> <para> <para>One or more Internet gateway IDs.</para><para>Default: Describes all your Internet gateways.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2KeyPairCmdlet"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2KeyPairCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>fingerprint</code> - The fingerprint of the key pair.</para></li><li><para><code>key-name</code> - The name of the key pair.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2KeyPairCmdlet.KeyName"> <summary> <para> <para>One or more key pair names.</para><para>Default: Describes all your key pairs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2MovingAddressCmdlet"> <summary> Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2MovingAddressCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>moving-status</code> - The status of the Elastic IP address (<code>MovingToVpc</code> | <code>RestoringToClassic</code>).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2MovingAddressCmdlet.PublicIp"> <summary> <para> <para>One or more Elastic IP addresses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2MovingAddressCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value outside of this range, an error is returned.</para><para>Default: If no value is provided, the default is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2MovingAddressCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkAclCmdlet"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkAclCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>association.association-id</code> - The ID of an association ID for the ACL.</para></li><li><para><code>association.network-acl-id</code> - The ID of the network ACL involved in the association.</para></li><li><para><code>association.subnet-id</code> - The ID of the subnet involved in the association.</para></li><li><para><code>default</code> - Indicates whether the ACL is the default network ACL for the VPC.</para></li><li><para><code>entry.cidr</code> - The CIDR range specified in the entry.</para></li><li><para><code>entry.egress</code> - Indicates whether the entry applies to egress traffic.</para></li><li><para><code>entry.icmp.code</code> - The ICMP code specified in the entry, if any.</para></li><li><para><code>entry.icmp.type</code> - The ICMP type specified in the entry, if any.</para></li><li><para><code>entry.port-range.from</code> - The start of the port range specified in the entry. </para></li><li><para><code>entry.port-range.to</code> - The end of the port range specified in the entry. </para></li><li><para><code>entry.protocol</code> - The protocol specified in the entry (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number).</para></li><li><para><code>entry.rule-action</code> - Allows or denies the matching traffic (<code>allow</code> | <code>deny</code>).</para></li><li><para><code>entry.rule-number</code> - The number of an entry (in other words, rule) in the ACL's set of entries.</para></li><li><para><code>network-acl-id</code> - The ID of the network ACL.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>vpc-id</code> - The ID of the VPC for the network ACL.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkAclCmdlet.NetworkAclId"> <summary> <para> <para>One or more network ACL IDs.</para><para>Default: Describes all your network ACLs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceCmdlet"> <summary> Describes one or more of your network interfaces. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>addresses.private-ip-address</code> - The private IP addresses associated with the network interface.</para></li><li><para><code>addresses.primary</code> - Whether the private IP address is the primary IP address associated with the network interface. </para></li><li><para><code>addresses.association.public-ip</code> - The association ID returned when the network interface was associated with the Elastic IP address.</para></li><li><para><code>addresses.association.owner-id</code> - The owner ID of the addresses associated with the network interface.</para></li><li><para><code>association.association-id</code> - The association ID returned when the network interface was associated with an IP address.</para></li><li><para><code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address for your network interface.</para></li><li><para><code>association.ip-owner-id</code> - The owner of the Elastic IP address associated with the network interface.</para></li><li><para><code>association.public-ip</code> - The address of the Elastic IP address bound to the network interface.</para></li><li><para><code>association.public-dns-name</code> - The public DNS name for the network interface.</para></li><li><para><code>attachment.attachment-id</code> - The ID of the interface attachment.</para></li><li><para><code>attachment.instance-id</code> - The ID of the instance to which the network interface is attached.</para></li><li><para><code>attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached.</para></li><li><para><code>attachment.device-index</code> - The device index to which the network interface is attached.</para></li><li><para><code>attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</para></li><li><para><code>attachment.attach.time</code> - The time that the network interface was attached to an instance.</para></li><li><para><code>attachment.delete-on-termination</code> - Indicates whether the attachment is deleted when an instance is terminated.</para></li><li><para><code>availability-zone</code> - The Availability Zone of the network interface.</para></li><li><para><code>description</code> - The description of the network interface.</para></li><li><para><code>group-id</code> - The ID of a security group associated with the network interface.</para></li><li><para><code>group-name</code> - The name of a security group associated with the network interface.</para></li><li><para><code>mac-address</code> - The MAC address of the network interface.</para></li><li><para><code>network-interface-id</code> - The ID of the network interface.</para></li><li><para><code>owner-id</code> - The AWS account ID of the network interface owner.</para></li><li><para><code>private-ip-address</code> - The private IP address or addresses of the network interface.</para></li><li><para><code>private-dns-name</code> - The private DNS name of the network interface.</para></li><li><para><code>requester-id</code> - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).</para></li><li><para><code>requester-managed</code> - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).</para></li><li><para><code>source-desk-check</code> - Indicates whether the network interface performs source/destination checking. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the network interface to perform Network Address Translation (NAT) in your VPC. </para></li><li><para><code>status</code> - The status of the network interface. If the network interface is not attached to an instance, the status is <code>available</code>; if a network interface is attached to an instance the status is <code>in-use</code>.</para></li><li><para><code>subnet-id</code> - The ID of the subnet for the network interface.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>vpc-id</code> - The ID of the VPC for the network interface.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceCmdlet.NetworkInterfaceId"> <summary> <para> <para>One or more network interface IDs.</para><para>Default: Describes all your network interfaces.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceAttributeCmdlet"> <summary> Describes a network interface attribute. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceAttributeCmdlet.Attachment"> <summary> <para> <para>The <c>attachment</c> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceAttributeCmdlet.Description"> <summary> <para> <para>The <c>description</c> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceAttributeCmdlet.Group"> <summary> <para> <para>The <c>groupSet</c> attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceAttributeCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2NetworkInterfaceAttributeCmdlet.SourceDestCheck"> <summary> <para> <para>The <c>sourceDestCheck</c> attribute.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2PlacementGroupCmdlet"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PlacementGroupCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>group-name</code> - The name of the placement group.</para></li><li><para><code>state</code> - The state of the placement group (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</para></li><li><para><code>strategy</code> - The strategy of the placement group (<code>cluster</code>).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PlacementGroupCmdlet.GroupName"> <summary> <para> <para>One or more placement group names.</para><para>Default: Describes all your placement groups, or only those otherwise specified.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2PrefixListCmdlet"> <summary> Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PrefixListCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>prefix-list-id</code>: The ID of a prefix list.</para></li><li><para><code>prefix-list-name</code>: The name of a prefix list.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PrefixListCmdlet.PrefixListId"> <summary> <para> <para>One or more prefix list IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PrefixListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.</para><para>Constraint: If the value specified is greater than 1000, we return only 1000 items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2PrefixListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a prior call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2RegionCmdlet"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2RegionCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>endpoint</code> - The endpoint of the region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</para></li><li><para><code>region-name</code> - The name of the region (for example, <code>us-east-1</code>).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2RegionCmdlet.RegionName"> <summary> <para> <para>The names of one or more regions.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstanceCmdlet"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstanceCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</para></li><li><para><code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</para></li><li><para><code>end</code> - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).</para></li><li><para><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</para></li><li><para><code>instance-type</code> - The instance type on which the Reserved Instance can be used.</para></li><li><para><code>product-description</code> - The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (<code>Linux/UNIX</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux (Amazon VPC)</code> | <code>Windows</code> | <code>Windows (Amazon VPC)</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Standard (Amazon VPC)</code> | <code>Windows with SQL Server Web</code> | <code>Windows with SQL Server Web (Amazon VPC)</code> | <code>Windows with SQL Server Enterprise</code> | <code>Windows with SQL Server Enterprise (Amazon VPC)</code>).</para></li><li><para><code>reserved-instances-id</code> - The ID of the Reserved Instance.</para></li><li><para><code>start</code> - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).</para></li><li><para><code>state</code> - The state of the Reserved Instance (<code>payment-pending</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>).</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstanceCmdlet.OfferingType"> <summary> <para> <para>The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstanceCmdlet.ReservedInstancesId"> <summary> <para> <para>One or more Reserved Instance IDs.</para><para>Default: Describes all your Reserved Instances, or only those otherwise specified.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesListingCmdlet"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para><para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para><para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesListingCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>reserved-instances-id</code> - The ID of the Reserved Instances.</para></li><li><para><code>reserved-instances-listing-id</code> - The ID of the Reserved Instances listing.</para></li><li><para><code>status</code> - The status of the Reserved Instance listing (<code>pending</code> | <code>active</code> | <code>cancelled</code> | <code>closed</code>).</para></li><li><para><code>status-message</code> - The reason for the status.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesListingCmdlet.ReservedInstancesId"> <summary> <para> <para>One or more Reserved Instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesListingCmdlet.ReservedInstancesListingId"> <summary> <para> <para>One or more Reserved Instance Listing IDs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesModificationsCmdlet"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesModificationsCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>client-token</code> - The idempotency token for the modification request.</para></li><li><para><code>create-date</code> - The time when the modification request was created.</para></li><li><para><code>effective-date</code> - The time when the modification becomes effective.</para></li><li><para><code>modification-result.reserved-instances-id</code> - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is <code>fulfilled</code>.</para></li><li><para><code>modification-result.target-configuration.availability-zone</code> - The Availability Zone for the new Reserved Instances.</para></li><li><para><code>modification-result.target-configuration.instance-count </code> - The number of new Reserved Instances.</para></li><li><para><code>modification-result.target-configuration.instance-type</code> - The instance type of the new Reserved Instances.</para></li><li><para><code>modification-result.target-configuration.platform</code> - The network platform of the new Reserved Instances (<code>EC2-Classic</code> | <code>EC2-VPC</code>).</para></li><li><para><code>reserved-instances-id</code> - The ID of the Reserved Instances modified.</para></li><li><para><code>reserved-instances-modification-id</code> - The ID of the modification request.</para></li><li><para><code>status</code> - The status of the Reserved Instances modification request (<code>processing</code> | <code>fulfilled</code> | <code>failed</code>).</para></li><li><para><code>status-message</code> - The reason for the status.</para></li><li><para><code>update-date</code> - The time when the modification request was last updated.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesModificationsCmdlet.ReservedInstancesModificationId"> <summary> <para> <para>IDs for the submitted modification request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesModificationsCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next page of results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone in which the Reserved Instance can be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</para></li><li><para><code>duration</code> - The duration of the Reserved Instance (for example, one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</para></li><li><para><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</para></li><li><para><code>instance-type</code> - The instance type on which the Reserved Instance can be used.</para></li><li><para><code>marketplace</code> - Set to <code>true</code> to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.</para></li><li><para><code>product-description</code> - The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (<code>Linux/UNIX</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux (Amazon VPC)</code> | <code>Windows</code> | <code>Windows (Amazon VPC)</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Standard (Amazon VPC)</code> | <code>Windows with SQL Server Web</code> | <code> Windows with SQL Server Web (Amazon VPC)</code> | <code>Windows with SQL Server Enterprise</code> | <code>Windows with SQL Server Enterprise (Amazon VPC)</code>) </para></li><li><para><code>reserved-instances-offering-id</code> - The Reserved Instances offering ID.</para></li><li><para><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.IncludeMarketplace"> <summary> <para> <para>Include Marketplace offerings in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.InstanceTenancy"> <summary> <para> <para>The tenancy of the Reserved Instance offering. A Reserved Instance with <code>dedicated</code> tenancy runs on single-tenant hardware and can only be launched within a VPC.</para><para>Default: <code>default</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.InstanceType"> <summary> <para> <para>The instance type on which the Reserved Instance can be used. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.MaxDuration"> <summary> <para> <para>The maximum duration (in seconds) to filter when searching for offerings.</para><para>Default: 94608000 (3 years)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.MaxInstanceCount"> <summary> <para> <para>The maximum number of instances to filter when searching for offerings.</para><para>Default: 20</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.MinDuration"> <summary> <para> <para>The minimum duration (in seconds) to filter when searching for offerings.</para><para>Default: 2592000 (1 month)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.OfferingType"> <summary> <para> <para>The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.ProductDescription"> <summary> <para> <para>The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the description are for use with Amazon VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.ReservedInstancesOfferingId"> <summary> <para> <para>One or more Reserved Instances offering IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. The maximum is 100.</para><para>Default: 100</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2ReservedInstancesOfferingCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next page of results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2RouteTableCmdlet"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para><para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2RouteTableCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>association.route-table-association-id</code> - The ID of an association ID for the route table.</para></li><li><para><code>association.route-table-id</code> - The ID of the route table involved in the association.</para></li><li><para><code>association.subnet-id</code> - The ID of the subnet involved in the association.</para></li><li><para><code>association.main</code> - Indicates whether the route table is the main route table for the VPC.</para></li><li><para><code>route-table-id</code> - The ID of the route table.</para></li><li><para><code>route.destination-cidr-block</code> - The CIDR range specified in a route in the table.</para></li><li><para><code>route.destination-prefix-list-id</code> - The ID (prefix) of the AWS service specified in a route in the table.</para></li><li><para><code>route.gateway-id</code> - The ID of a gateway specified in a route in the table.</para></li><li><para><code>route.instance-id</code> - The ID of an instance specified in a route in the table.</para></li><li><para><code>route.origin</code> - Describes how the route was created. <code>CreateRouteTable</code> indicates that the route was automatically created when the route table was created; <code>CreateRoute</code> indicates that the route was manually added to the route table; <code>EnableVgwRoutePropagation</code> indicates that the route was propagated by route propagation.</para></li><li><para><code>route.state</code> - The state of a route in the route table (<code>active</code> | <code>blackhole</code>). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).</para></li><li><para><code>route.vpc-peering-connection-id</code> - The ID of a VPC peering connection specified in a route in the table.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>vpc-id</code> - The ID of the VPC for the route table.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2RouteTableCmdlet.RouteTableId"> <summary> <para> <para>One or more route table IDs.</para><para>Default: Describes all your route tables.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SecurityGroupCmdlet"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SecurityGroupCmdlet.Filter"> <summary> <para> <para>One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.</para><ul><li><para><code>description</code> - The description of the security group.</para></li><li><para><code>egress.ip-permission.prefix-list-id</code> - The ID (prefix) of the AWS service to which the security group allows access.</para></li><li><para><code>group-id</code> - The ID of the security group. </para></li><li><para><code>group-name</code> - The name of the security group.</para></li><li><para><code>ip-permission.cidr</code> - A CIDR range that has been granted permission.</para></li><li><para><code>ip-permission.from-port</code> - The start of port range for the TCP and UDP protocols, or an ICMP type number.</para></li><li><para><code>ip-permission.group-id</code> - The ID of a security group that has been granted permission.</para></li><li><para><code>ip-permission.group-name</code> - The name of a security group that has been granted permission.</para></li><li><para><code>ip-permission.protocol</code> - The IP protocol for the permission (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number).</para></li><li><para><code>ip-permission.to-port</code> - The end of port range for the TCP and UDP protocols, or an ICMP code.</para></li><li><para><code>ip-permission.user-id</code> - The ID of an AWS account that has been granted permission.</para></li><li><para><code>owner-id</code> - The AWS account ID of the owner of the security group.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the security group.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the security group.</para></li><li><para><code>vpc-id</code> - The ID of the VPC specified when the security group was created.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SecurityGroupCmdlet.GroupId"> <summary> <para> <para>One or more security group IDs. Required for security groups in a nondefault VPC.</para><para>Default: Describes all your security groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SecurityGroupCmdlet.GroupName"> <summary> <para> <para>[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the <code>group-name</code> filter to describe security groups by name.</para><para>Default: Describes all your security groups.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotCmdlet"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para><ul><li><i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li><li><i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li><li><i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li></ul><para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para><para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para><para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para><para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para><para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para><para> For more information about EBS snapshots, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html">Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>description</code> - A description of the snapshot.</para></li><li><para><code>owner-alias</code> - The AWS account alias (for example, <code>amazon</code>) that owns the snapshot.</para></li><li><para><code>owner-id</code> - The ID of the AWS account that owns the snapshot.</para></li><li><para><code>progress</code> - The progress of the snapshot, as a percentage (for example, 80%).</para></li><li><para><code>snapshot-id</code> - The snapshot ID.</para></li><li><para><code>start-time</code> - The time stamp when the snapshot was initiated.</para></li><li><para><code>status</code> - The status of the snapshot (<code>pending</code> | <code>completed</code> | <code>error</code>).</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>volume-id</code> - The ID of the volume the snapshot is for.</para></li><li><para><code>volume-size</code> - The size of the volume, in GiB.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotCmdlet.OwnerId"> <summary> <para> <para>Returns the snapshots owned by the specified owner. Multiple owners can be specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotCmdlet.RestorableByUserId"> <summary> <para> <para>One or more AWS accounts IDs that can create volumes from the snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotCmdlet.SnapshotId"> <summary> <para> <para>One or more snapshot IDs.</para><para>Default: Describes snapshots for which you have launch permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotCmdlet.MaxResult"> <summary> <para> <para>The maximum number of snapshot results returned by <code>DescribeSnapshots</code> in paginated output. When this parameter is used, <code>DescribeSnapshots</code> only returns <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeSnapshots</code> request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then <code>DescribeSnapshots</code> returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value returned from a previous paginated <code>DescribeSnapshots</code> request where <code>MaxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>NextToken</code> value. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotAttributeCmdlet"> <summary> Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. <para> For more information about EBS snapshots, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html">Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotAttributeCmdlet.Attribute"> <summary> <para> <para>The snapshot attribute you would like to view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SnapshotAttributeCmdlet.SnapshotId"> <summary> <para> <para>The ID of the EBS snapshot.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotDatafeedSubscriptionCmdlet"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetInstanceCmdlet"> <summary> Describes the running instances for the specified Spot fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetInstanceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetInstanceCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetInstanceCmdlet.SpotFleetRequestId"> <summary> <para> <para>The ID of the Spot fleet request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestCmdlet"> <summary> Describes your Spot fleet requests. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestCmdlet.SpotFleetRequestId"> <summary> <para> <para>The IDs of the Spot fleet requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestHistoryCmdlet"> <summary> Describes the events for the specified Spot fleet request during the specified time. <para> Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestHistoryCmdlet.EventType"> <summary> <para> <para>The type of events to describe. By default, all events are described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestHistoryCmdlet.StartTime"> <summary> <para> <para>The starting date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestHistoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestHistoryCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotFleetRequestHistoryCmdlet.SpotFleetRequestId"> <summary> <para> <para>The ID of the Spot fleet request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotInstanceRequestCmdlet"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotInstanceRequestCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>availability-zone-group</code> - The Availability Zone group.</para></li><li><para><code>create-time</code> - The time stamp when the Spot instance request was created.</para></li><li><para><code>fault-code</code> - The fault code related to the request.</para></li><li><para><code>fault-message</code> - The fault message related to the request.</para></li><li><para><code>instance-id</code> - The ID of the instance that fulfilled the request.</para></li><li><para><code>launch-group</code> - The Spot instance launch group.</para></li><li><para><code>launch.block-device-mapping.delete-on-termination</code> - Indicates whether the Amazon EBS volume is deleted on instance termination.</para></li><li><para><code>launch.block-device-mapping.device-name</code> - The device name for the Amazon EBS volume (for example, <code>/dev/sdh</code>).</para></li><li><para><code>launch.block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume.</para></li><li><para><code>launch.block-device-mapping.volume-size</code> - The size of the Amazon EBS volume, in GiB.</para></li><li><para><code>launch.block-device-mapping.volume-type</code> - The type of the Amazon EBS volume (<code>gp2</code> | <code>standard</code> | <code>io1</code>).</para></li><li><para><code>launch.group-id</code> - The security group for the instance.</para></li><li><para><code>launch.image-id</code> - The ID of the AMI.</para></li><li><para><code>launch.instance-type</code> - The type of instance (for example, <code>m1.small</code>).</para></li><li><para><code>launch.kernel-id</code> - The kernel ID.</para></li><li><para><code>launch.key-name</code> - The name of the key pair the instance launched with.</para></li><li><para><code>launch.monitoring-enabled</code> - Whether monitoring is enabled for the Spot instance.</para></li><li><para><code>launch.ramdisk-id</code> - The RAM disk ID.</para></li><li><para><code>network-interface.network-interface-id</code> - The ID of the network interface.</para></li><li><para><code>network-interface.device-index</code> - The index of the device for the network interface attachment on the instance.</para></li><li><para><code>network-interface.subnet-id</code> - The ID of the subnet for the instance.</para></li><li><para><code>network-interface.description</code> - A description of the network interface.</para></li><li><para><code>network-interface.private-ip-address</code> - The primary private IP address of the network interface.</para></li><li><para><code>network-interface.delete-on-termination</code> - Indicates whether the network interface is deleted when the instance is terminated.</para></li><li><para><code>network-interface.group-id</code> - The ID of the security group associated with the network interface.</para></li><li><para><code>network-interface.group-name</code> - The name of the security group associated with the network interface.</para></li><li><para><code>network-interface.addresses.primary</code> - Indicates whether the IP address is the primary private IP address.</para></li><li><para><code>product-description</code> - The product description associated with the instance (<code>Linux/UNIX</code> | <code>Windows</code>).</para></li><li><para><code>spot-instance-request-id</code> - The Spot instance request ID.</para></li><li><para><code>spot-price</code> - The maximum hourly price for any Spot instance launched to fulfill the request.</para></li><li><para><code>state</code> - The state of the Spot instance request (<code>open</code> | <code>active</code> | <code>closed</code> | <code>cancelled</code> | <code>failed</code>). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html">Spot Bid Status</a> in the Amazon Elastic Compute Cloud User Guide.</para></li><li><para><code>status-code</code> - The short code describing the most recent evaluation of your Spot instance request.</para></li><li><para><code>status-message</code> - The message explaining the status of the Spot instance request.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>type</code> - The type of Spot instance request (<code>one-time</code> | <code>persistent</code>).</para></li><li><para><code>launched-availability-zone</code> - The Availability Zone in which the bid is launched.</para></li><li><para><code>valid-from</code> - The start date of the request.</para></li><li><para><code>valid-until</code> - The end date of the request.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotInstanceRequestCmdlet.SpotInstanceRequestId"> <summary> <para> <para>One or more Spot instance request IDs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet.AvailabilityZone"> <summary> <para> <para>Filters the results by the specified Availability Zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet.EndTime"> <summary> <para> <para>The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>availability-zone</code> - The Availability Zone for which prices should be returned.</para></li><li><para><code>instance-type</code> - The type of instance (for example, <code>m1.small</code>).</para></li><li><para><code>product-description</code> - The product description for the Spot price (<code>Linux/UNIX</code> | <code>SUSE Linux</code> | <code>Windows</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Windows (Amazon VPC)</code>).</para></li><li><para><code>spot-price</code> - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).</para></li><li><para><code>timestamp</code> - The timestamp of the Spot price history, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet.InstanceType"> <summary> <para> <para>Filters the results by the specified instance types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet.ProductDescription"> <summary> <para> <para>Filters the results by the specified basic product descriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet.StartTime"> <summary> <para> <para>The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SpotPriceHistoryCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2SubnetCmdlet"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SubnetCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>availabilityZone</code> - The Availability Zone for the subnet. You can also use <code>availability-zone</code> as the filter name.</para></li><li><para><code>available-ip-address-count</code> - The number of IP addresses in the subnet that are available.</para></li><li><para><code>cidrBlock</code> - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use <code>cidr</code> or <code>cidr-block</code> as the filter names.</para></li><li><para><code>defaultForAz</code> - Indicates whether this is the default subnet for the Availability Zone. You can also use <code>default-for-az</code> as the filter name.</para></li><li><para><code>state</code> - The state of the subnet (<code>pending</code> | <code>available</code>).</para></li><li><para><code>subnet-id</code> - The ID of the subnet.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>vpc-id</code> - The ID of the VPC for the subnet.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2SubnetCmdlet.SubnetId"> <summary> <para> <para>One or more subnet IDs.</para><para>Default: Describes all your subnets.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2TagCmdlet"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2TagCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>key</code> - The tag key.</para></li><li><para><code>resource-id</code> - The resource ID.</para></li><li><para><code>resource-type</code> - The resource type (<code>customer-gateway</code> | <code>dhcp-options</code> | <code>image</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-interface</code> | <code>reserved-instances</code> | <code>route-table</code> | <code>security-group</code> | <code>snapshot</code> | <code>spot-instances-request</code> | <code>subnet</code> | <code>volume</code> | <code>vpc</code> | <code>vpn-connection</code> | <code>vpn-gateway</code>).</para></li><li><para><code>value</code> - The tag value.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2TagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2TagCmdlet.NextToken"> <summary> <para> <para>The token to retrieve the next page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeCmdlet"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para><para> For more information about EBS volumes, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html">Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>attachment.attach-time</code> - The time stamp when the attachment initiated.</para></li><li><para><code>attachment.delete-on-termination</code> - Whether the volume is deleted on instance termination.</para></li><li><para><code>attachment.device</code> - The device name that is exposed to the instance (for example, <code>/dev/sda1</code>).</para></li><li><para><code>attachment.instance-id</code> - The ID of the instance the volume is attached to.</para></li><li><para><code>attachment.status</code> - The attachment state (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</para></li><li><para><code>availability-zone</code> - The Availability Zone in which the volume was created.</para></li><li><para><code>create-time</code> - The time stamp when the volume was created.</para></li><li><para><code>encrypted</code> - The encryption status of the volume.</para></li><li><para><code>size</code> - The size of the volume, in GiB.</para></li><li><para><code>snapshot-id</code> - The snapshot from which the volume was created.</para></li><li><para><code>status</code> - The status of the volume (<code>creating</code> | <code>available</code> | <code>in-use</code> | <code>deleting</code> | <code>deleted</code> | <code>error</code>).</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>volume-id</code> - The volume ID.</para></li><li><para><code>volume-type</code> - The Amazon EBS volume type. This can be <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, or <code>standard</code> for Magnetic volumes.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeCmdlet.VolumeId"> <summary> <para> <para>One or more volume IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeCmdlet.MaxResult"> <summary> <para> <para>The maximum number of volume results returned by <code>DescribeVolumes</code> in paginated output. When this parameter is used, <code>DescribeVolumes</code> only returns <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeVolumes</code> request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then <code>DescribeVolumes</code> returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value returned from a previous paginated <code>DescribeVolumes</code> request where <code>MaxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>NextToken</code> value. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeAttributeCmdlet"> <summary> Describes the specified attribute of the specified volume. You can specify only one attribute at a time. <para> For more information about EBS volumes, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html">Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeAttributeCmdlet.Attribute"> <summary> <para> <para>The instance attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeAttributeCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeStatusCmdlet"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para><para><i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para><para><i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para><para><i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para><note><para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeStatusCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>action.code</code> - The action code for the event (for example, <code>enable-volume-io</code>).</para></li><li><para><code>action.description</code> - A description of the action.</para></li><li><para><code>action.event-id</code> - The event ID associated with the action.</para></li><li><para><code>availability-zone</code> - The Availability Zone of the instance.</para></li><li><para><code>event.description</code> - A description of the event.</para></li><li><para><code>event.event-id</code> - The event ID.</para></li><li><para><code>event.event-type</code> - The event type (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>; for <code>io-performance</code>: <code>io-performance:degraded</code> | <code>io-performance:severely-degraded</code> | <code>io-performance:stalled</code>).</para></li><li><para><code>event.not-after</code> - The latest end time for the event.</para></li><li><para><code>event.not-before</code> - The earliest start time for the event.</para></li><li><para><code>volume-status.details-name</code> - The cause for <code>volume-status.status</code> (<code>io-enabled</code> | <code>io-performance</code>).</para></li><li><para><code>volume-status.details-status</code> - The status of <code>volume-status.details-name</code> (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>; for <code>io-performance</code>: <code>normal</code> | <code>degraded</code> | <code>severely-degraded</code> | <code>stalled</code>).</para></li><li><para><code>volume-status.status</code> - The status of the volume (<code>ok</code> | <code>impaired</code> | <code>warning</code> | <code>insufficient-data</code>).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeStatusCmdlet.VolumeId"> <summary> <para> <para>One or more volume IDs.</para><para>Default: Describes all your volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeStatusCmdlet.MaxResult"> <summary> <para> <para>The maximum number of volume results returned by <code>DescribeVolumeStatus</code> in paginated output. When this parameter is used, the request only returns <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then <code>DescribeVolumeStatus</code> returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VolumeStatusCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value to include in a future <code>DescribeVolumeStatus</code> request. When the results of the request exceed <code>MaxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcCmdlet"> <summary> Describes one or more of your VPCs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>cidr</code> - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, <code>/28</code>).</para></li><li><para><code>dhcp-options-id</code> - The ID of a set of DHCP options.</para></li><li><para><code>isDefault</code> - Indicates whether the VPC is the default VPC.</para></li><li><para><code>state</code> - The state of the VPC (<code>pending</code> | <code>available</code>).</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>vpc-id</code> - The ID of the VPC.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcCmdlet.VpcId"> <summary> <para> <para>One or more VPC IDs.</para><para>Default: Describes all your VPCs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcAttributeCmdlet"> <summary> Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcAttributeCmdlet.Attribute"> <summary> <para> <para>The VPC attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcAttributeCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcClassicLinkCmdlet"> <summary> Describes the ClassicLink status of one or more VPCs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcClassicLinkCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>is-classic-link-enabled</code> - Whether the VPC is enabled for ClassicLink (<code>true</code> | <code>false</code>).</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcClassicLinkCmdlet.VpcId"> <summary> <para> <para>One or more VPCs for which you want to describe the ClassicLink status.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcEndpointCmdlet"> <summary> Describes one or more of your VPC endpoints. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcEndpointCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>service-name</code>: The name of the AWS service.</para></li><li><para><code>vpc-id</code>: The ID of the VPC in which the endpoint resides.</para></li><li><para><code>vpc-endpoint-id</code>: The ID of the endpoint.</para></li><li><para><code>vpc-endpoint-state</code>: The state of the endpoint. (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>)</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcEndpointCmdlet.VpcEndpointId"> <summary> <para> <para>One or more endpoint IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcEndpointCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.</para><para>Constraint: If the value is greater than 1000, we return only 1000 items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcEndpointCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a prior call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcEndpointServiceCmdlet"> <summary> Describes all supported AWS services that can be specified when creating a VPC endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcEndpointServiceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.</para><para>Constraint: If the value is greater than 1000, we return only 1000 items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcEndpointServiceCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a prior call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcPeeringConnectionsCmdlet"> <summary> Describes one or more of your VPC peering connections. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcPeeringConnectionsCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>accepter-vpc-info.cidr-block</code> - The CIDR block of the peer VPC.</para></li><li><para><code>accepter-vpc-info.owner-id</code> - The AWS account ID of the owner of the peer VPC.</para></li><li><para><code>accepter-vpc-info.vpc-id</code> - The ID of the peer VPC.</para></li><li><para><code>expiration-time</code> - The expiration date and time for the VPC peering connection.</para></li><li><para><code>requester-vpc-info.cidr-block</code> - The CIDR block of the requester's VPC.</para></li><li><para><code>requester-vpc-info.owner-id</code> - The AWS account ID of the owner of the requester VPC.</para></li><li><para><code>requester-vpc-info.vpc-id</code> - The ID of the requester VPC.</para></li><li><para><code>status-code</code> - The status of the VPC peering connection (<code>pending-acceptance</code> | <code>failed</code> | <code>expired</code> | <code>provisioning</code> | <code>active</code> | <code>deleted</code> | <code>rejected</code>).</para></li><li><para><code>status-message</code> - A message that provides more information about the status of the VPC peering connection, if applicable.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>vpc-peering-connection-id</code> - The ID of the VPC peering connection.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpcPeeringConnectionsCmdlet.VpcPeeringConnectionId"> <summary> <para> <para>One or more VPC peering connection IDs.</para><para>Default: Describes all your VPC peering connections.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpnConnectionCmdlet"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpnConnectionCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>customer-gateway-configuration</code> - The configuration information for the customer gateway.</para></li><li><para><code>customer-gateway-id</code> - The ID of a customer gateway associated with the VPN connection.</para></li><li><para><code>state</code> - The state of the VPN connection (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</para></li><li><para><code>option.static-routes-only</code> - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).</para></li><li><para><code>route.destination-cidr-block</code> - The destination CIDR block. This corresponds to the subnet used in a customer data center.</para></li><li><para><code>bgp-asn</code> - The BGP Autonomous System Number (ASN) associated with a BGP device.</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>type</code> - The type of VPN connection. Currently the only supported type is <code>ipsec.1</code>.</para></li><li><para><code>vpn-connection-id</code> - The ID of the VPN connection.</para></li><li><para><code>vpn-gateway-id</code> - The ID of a virtual private gateway associated with the VPN connection.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpnConnectionCmdlet.VpnConnectionId"> <summary> <para> <para>One or more VPN connection IDs.</para><para>Default: Describes your VPN connections.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpnGatewayCmdlet"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpnGatewayCmdlet.Filter"> <summary> <para> <para>One or more filters.</para><ul><li><para><code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</para></li><li><para><code>attachment.vpc-id</code> - The ID of an attached VPC.</para></li><li><para><code>availability-zone</code> - The Availability Zone for the virtual private gateway.</para></li><li><para><code>state</code> - The state of the virtual private gateway (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</para></li><li><para><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</para></li><li><para><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</para></li><li><para><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</para></li><li><para><code>type</code> - The type of virtual private gateway. Currently the only supported type is <code>ipsec.1</code>.</para></li><li><para><code>vpn-gateway-id</code> - The ID of the virtual private gateway.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GetEC2VpnGatewayCmdlet.VpnGatewayId"> <summary> <para> <para>One or more virtual private gateway IDs.</para><para>Default: Describes all your virtual private gateways.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupEgressCmdlet"> <summary> Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. <important><para> You can have up to 50 rules per security group (covering both ingress and egress rules). </para></important><para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para><para> Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. </para><para> Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupEgressCmdlet.GroupId"> <summary> <para> <para>The ID of the security group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupEgressCmdlet.IpPermission"> <summary> <para> <para>A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupEgressCmdlet.PassThru"> <summary> Returns the value passed to the GroupId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupEgressCmdlet.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.EC2.GrantEC2SecurityGroupIngressCmdlet"> <summary> Adds one or more ingress rules to a security group. <important><para> EC2-Classic: You can have up to 100 rules per group. </para><para> EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules). </para></important><para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para><para> [EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the <i>source groups</i>) permission to access a security group for your account. A source group can be for your own AWS account, or another. </para><para> [EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the <i>source groups</i>) permission to access a security group for your VPC. The security groups must all be for the same VPC. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupIngressCmdlet.GroupId"> <summary> <para> <para>The ID of the security group. Required for a nondefault VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupIngressCmdlet.GroupName"> <summary> <para> <para>[EC2-Classic, default VPC] The name of the security group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupIngressCmdlet.IpPermission"> <summary> <para> <para>A set of IP permissions. Can be used to specify multiple rules in a single command. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupIngressCmdlet.PassThru"> <summary> Returns the value passed to the GroupId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.GrantEC2SecurityGroupIngressCmdlet.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.EC2.ImportEC2ImageCmdlet"> <summary> Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.Architecture"> <summary> <para> <para>The architecture of the virtual machine.</para><para>Valid values: <code>i386</code> | <code>x86_64</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.ClientToken"> <summary> <para> <para>The token to enable idempotency for VM import requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.ClientData_Comment"> <summary> <para> <para>A user-defined comment about the disk upload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.Description"> <summary> <para> <para>A description string for the import image task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.DiskContainer"> <summary> <para> <para>Information about the disk containers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.Hypervisor"> <summary> <para> <para>The target hypervisor platform.</para><para>Valid values: <code>xen</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.LicenseType"> <summary> <para> <para>The license type to be used for the Amazon Machine Image (AMI) after importing.</para><para><b>Note:</b> You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html">VM Import/Export Prerequisites</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para><para>Valid values: <code>AWS</code> | <code>BYOL</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.Platform"> <summary> <para> <para>The operating system of the virtual machine.</para><para>Valid values: <code>Windows</code> | <code>Linux</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.RoleName"> <summary> <para> <para>The name of the role to use when not using the default role, 'vmimport'.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.ClientData_UploadEnd"> <summary> <para> <para>The time that the disk upload ends.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.ClientData_UploadSize"> <summary> <para> <para>The size of the uploaded disk image, in GiB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.ClientData_UploadStart"> <summary> <para> <para>The time that the disk upload starts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2ImageCmdlet.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.EC2.ImportEC2KeyPairCmdlet"> <summary> Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with <a>CreateKeyPair</a>, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2KeyPairCmdlet.KeyName"> <summary> <para> <para>A unique name for the key pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2KeyPairCmdlet.PublicKeyMaterial"> <summary> <para> <para>The public key. You must base64 encode the public key material before sending it to AWS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2KeyPairCmdlet.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.EC2.ImportEC2SnapshotCmdlet"> <summary> Imports a disk into an EBS snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.ClientToken"> <summary> <para> <para>Token to enable idempotency for VM import requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.ClientData_Comment"> <summary> <para> <para>A user-defined comment about the disk upload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.Description"> <summary> <para> <para>The description string for the import snapshot task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.DiskContainer_Description"> <summary> <para> <para>The description of the disk image being imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.DiskContainer_Format"> <summary> <para> <para>The format of the disk image being imported.</para><para>Valid values: <code>RAW</code> | <code>VHD</code> | <code>VMDK</code> | <code>OVA</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.RoleName"> <summary> <para> <para>The name of the role to use when not using the default role, 'vmimport'.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.DiskContainer_S3Bucket"> <summary> <para> <para>The name of the S3 bucket where the disk image is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.DiskContainer_S3Key"> <summary> <para> <para>The key for the disk image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.ClientData_UploadEnd"> <summary> <para> <para>The time that the disk upload ends.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.ClientData_UploadSize"> <summary> <para> <para>The size of the uploaded disk image, in GiB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.ClientData_UploadStart"> <summary> <para> <para>The time that the disk upload starts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.DiskContainer_Url"> <summary> <para> <para>The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ImportEC2SnapshotCmdlet.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.EC2.MoveEC2AddressToVpcCmdlet"> <summary> Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the <a>RestoreAddressToClassic</a> request. You cannot move an Elastic IP address that's allocated for use in the EC2-VPC platform to the EC2-Classic platform. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.MoveEC2AddressToVpcCmdlet.PublicIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.MoveEC2AddressToVpcCmdlet.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.EC2.NewEC2AddressCmdlet"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2AddressCmdlet.Domain"> <summary> <para> <para>Set to <code>vpc</code> to allocate the address for use with instances in a VPC.</para><para>Default: The address is for use with instances in EC2-Classic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2AddressCmdlet.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.EC2.NewEC2CustomerGatewayCmdlet"> <summary> Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT). <para> For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range). </para><note><para> Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the <code>us-east-1</code> region, and 9059, which is reserved in the <code>eu-west-1</code> region. </para></note><para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para><important><para> You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2CustomerGatewayCmdlet.BgpAsn"> <summary> <para> <para>For devices that support BGP, the customer gateway's BGP ASN.</para><para>Default: 65000</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2CustomerGatewayCmdlet.PublicIp"> <summary> <para> <para>The Internet-routable IP address for the customer gateway's outside interface. The address must be static.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2CustomerGatewayCmdlet.Type"> <summary> <para> <para>The type of VPN connection that this customer gateway supports (<code>ipsec.1</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2CustomerGatewayCmdlet.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.EC2.NewEC2DhcpOptionCmdlet"> <summary> Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. <ul><li><code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or <code>AmazonProvidedDNS</code>. The default DHCP option set specifies <code>AmazonProvidedDNS</code>. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li><li><code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>, specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another region, specify <code>region.compute.internal</code> (for example, <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for example, <code>MyCompany.com</code>). <b>Important</b>: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.</li><li><code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li><li><code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name servers.</li><li><code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. </li></ul><para> Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the <code>domain-name-servers</code> option either to <code>AmazonProvidedDNS</code> or to a domain name server of your choice. For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2DhcpOptionCmdlet.DhcpConfiguration"> <summary> <para> <para>A DHCP configuration option.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2DhcpOptionCmdlet.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.EC2.NewEC2FlowLogsCmdlet"> <summary> Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs. <para> In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2FlowLogsCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2FlowLogsCmdlet.DeliverLogsPermissionArn"> <summary> <para> <para>The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2FlowLogsCmdlet.LogGroupName"> <summary> <para> <para>The name of the CloudWatch log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2FlowLogsCmdlet.ResourceId"> <summary> <para> <para>One or more subnet, network interface, or VPC IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2FlowLogsCmdlet.ResourceType"> <summary> <para> <para>The type of resource on which to create the flow log.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2FlowLogsCmdlet.TrafficType"> <summary> <para> <para>The type of traffic to log.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2FlowLogsCmdlet.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.EC2.NewEC2ImageCmdlet"> <summary> Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. <para> If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Creating Amazon EBS-Backed Linux AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ImageCmdlet.BlockDeviceMapping"> <summary> <para> <para>Information about one or more block device mappings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ImageCmdlet.Description"> <summary> <para> <para>A description for the new image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ImageCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ImageCmdlet.Name"> <summary> <para> <para>A name for the new image.</para><para>Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ImageCmdlet.NoReboot"> <summary> <para> <para>By default, this parameter is set to <code>false</code>, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to <code>true</code>, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ImageCmdlet.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.EC2.NewEC2InstanceBundleCmdlet"> <summary> Bundles an Amazon instance store-backed Windows instance. <para> During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </para><note><para> This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. </para></note><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html">Creating an Instance Store-Backed Windows AMI</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceBundleCmdlet.S3_AWSAccessKeyId"> <summary> <para> <para>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">Best Practices for Managing AWS Access Keys</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceBundleCmdlet.S3_Bucket"> <summary> <para> <para>The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceBundleCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance to bundle.</para><para>Type: String</para><para>Default: None</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceBundleCmdlet.S3_Prefix"> <summary> <para> <para>The beginning of the file name of the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceBundleCmdlet.S3_UploadPolicy"> <summary> <para> <para>A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceBundleCmdlet.S3_UploadPolicySignature"> <summary> <para> <para>The signature of the Base64 encoded JSON document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceBundleCmdlet.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.EC2.NewEC2InstanceExportTaskCmdlet"> <summary> Exports a running or stopped instance to an S3 bucket. <para> For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ExportingEC2Instances.html">Exporting EC2 Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceExportTaskCmdlet.ExportToS3Task_ContainerFormat"> <summary> <para> <para>The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceExportTaskCmdlet.Description"> <summary> <para> <para>A description for the conversion task or the resource being exported. The maximum length is 255 bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceExportTaskCmdlet.ExportToS3Task_DiskImageFormat"> <summary> <para> <para>The format for the exported image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceExportTaskCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceExportTaskCmdlet.ExportToS3Task_S3Bucket"> <summary> <para> <para>The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account <code>vm-import-export@amazon.com</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceExportTaskCmdlet.ExportToS3Task_S3Prefix"> <summary> <para> <para>The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceExportTaskCmdlet.TargetEnvironment"> <summary> <para> <para>The target virtualization environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InstanceExportTaskCmdlet.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.EC2.NewEC2InternetGatewayCmdlet"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2InternetGatewayCmdlet.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.EC2.NewEC2KeyPairCmdlet"> <summary> Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. <para> You can have up to five thousand key pairs per region. </para><para> The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use <a>ImportKeyPair</a>. </para><para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2KeyPairCmdlet.KeyName"> <summary> <para> <para>A unique name for the key pair.</para><para>Constraints: Up to 255 ASCII characters</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2KeyPairCmdlet.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.EC2.NewEC2NetworkAclCmdlet"> <summary> Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclCmdlet.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.EC2.NewEC2NetworkAclEntryCmdlet"> <summary> Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. <para> We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. </para><para> After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. </para><para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.CidrBlock"> <summary> <para> <para>The network range to allow or deny, in CIDR notation (for example <code>172.16.0.0/24</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.IcmpTypeCode_Code"> <summary> <para> <para>The ICMP type. A value of -1 means all types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.Egress"> <summary> <para> <para>Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.PortRange_From"> <summary> <para> <para>The first port in the range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.NetworkAclId"> <summary> <para> <para>The ID of the network ACL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.Protocol"> <summary> <para> <para>The protocol. A value of -1 means all protocols.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.RuleAction"> <summary> <para> <para>Indicates whether to allow or deny the traffic that matches the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.RuleNumber"> <summary> <para> <para>The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.</para><para>Constraints: Positive integer from 1 to 32766</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.PortRange_To"> <summary> <para> <para>The last port in the range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.IcmpTypeCode_Type"> <summary> <para> <para>The ICMP code. A value of -1 means all codes for the specified ICMP type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.PassThru"> <summary> Returns the value passed to the NetworkAclId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkAclEntryCmdlet.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.EC2.NewEC2NetworkInterfaceCmdlet"> <summary> Creates a network interface in the specified subnet. <para> For more information about network interfaces, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkInterfaceCmdlet.Description"> <summary> <para> <para>A description for the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkInterfaceCmdlet.Group"> <summary> <para> <para>The IDs of one or more security groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkInterfaceCmdlet.PrivateIpAddress"> <summary> <para> <para>The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in <code>privateIpAddresses</code> as primary (only one IP address can be designated as primary).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkInterfaceCmdlet.PrivateIpAddressSet"> <summary> <para> <para>One or more private IP addresses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkInterfaceCmdlet.SecondaryPrivateIpAddressCount"> <summary> <para> <para>The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using <code>privateIpAddresses</code>.</para><para>The number of IP addresses you can assign to a network interface varies by instance type. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI">Private IP Addresses Per ENI Per Instance Type</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkInterfaceCmdlet.SubnetId"> <summary> <para> <para>The ID of the subnet to associate with the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2NetworkInterfaceCmdlet.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.EC2.NewEC2PlacementGroupCmdlet"> <summary> Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account. <para> For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2PlacementGroupCmdlet.GroupName"> <summary> <para> <para>A name for the placement group.</para><para>Constraints: Up to 255 ASCII characters</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2PlacementGroupCmdlet.Strategy"> <summary> <para> <para>The placement strategy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2PlacementGroupCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2PlacementGroupCmdlet.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.EC2.NewEC2ReservedInstanceCmdlet"> <summary> Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to on-Demand Instance pricing. <para> Use <a>DescribeReservedInstancesOfferings</a> to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with <a>DescribeReservedInstances</a>. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstanceCmdlet.LimitPrice_Amount"> <summary> <para> <para>Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstanceCmdlet.LimitPrice_CurrencyCode"> <summary> <para> <para>The currency in which the <code>limitPrice</code> amount is specified. At this time, the only supported currency is <code>USD</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstanceCmdlet.InstanceCount"> <summary> <para> <para>The number of Reserved Instances to purchase.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstanceCmdlet.ReservedInstancesOfferingId"> <summary> <para> <para>The ID of the Reserved Instance offering to purchase.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstanceCmdlet.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.EC2.NewEC2ReservedInstancesListingCmdlet"> <summary> Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the <a>DescribeReservedInstances</a> operation. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para><para> To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the <a>DescribeReservedInstancesListings</a> operation. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstancesListingCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstancesListingCmdlet.InstanceCount"> <summary> <para> <para>The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstancesListingCmdlet.PriceSchedule"> <summary> <para> <para>A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstancesListingCmdlet.ReservedInstancesId"> <summary> <para> <para>The ID of the active Reserved Instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2ReservedInstancesListingCmdlet.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.EC2.NewEC2RouteCmdlet"> <summary> Creates a route in a route table within a VPC. <para> You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. </para><para> When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for <code>192.0.2.3</code>, and the route table includes the following two routes: </para><ul><li><para><code>192.0.2.0/24</code> (goes to some target A) </para></li><li><para><code>192.0.2.0/28</code> (goes to some target B) </para></li></ul><para> Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. </para><para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteCmdlet.DestinationCidrBlock"> <summary> <para> <para>The CIDR address block used for the destination match. Routing decisions are based on the most specific match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteCmdlet.GatewayId"> <summary> <para> <para>The ID of an Internet gateway or virtual private gateway attached to your VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteCmdlet.InstanceId"> <summary> <para> <para>The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of a network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteCmdlet.RouteTableId"> <summary> <para> <para>The ID of the route table for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteCmdlet.VpcPeeringConnectionId"> <summary> <para> <para>The ID of a VPC peering connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteCmdlet.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.EC2.NewEC2RouteTableCmdlet"> <summary> Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteTableCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2RouteTableCmdlet.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.EC2.NewEC2SecurityGroupCmdlet"> <summary> Creates a security group. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para><important><para> EC2-Classic: You can have up to 500 security groups. </para><para> EC2-VPC: You can create up to 100 security groups per VPC. </para></important><para> When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. </para><para> You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. </para><para> You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SecurityGroupCmdlet.Description"> <summary> <para> <para>A description for the security group. This is informational only.</para><para>Constraints: Up to 255 characters in length</para><para>Constraints for EC2-Classic: ASCII characters</para><para>Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SecurityGroupCmdlet.GroupName"> <summary> <para> <para>The name of the security group.</para><para>Constraints: Up to 255 characters in length</para><para>Constraints for EC2-Classic: ASCII characters</para><para>Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SecurityGroupCmdlet.VpcId"> <summary> <para> <para>[EC2-VPC] The ID of the VPC. Required for EC2-VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SecurityGroupCmdlet.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.EC2.NewEC2SnapshotCmdlet"> <summary> Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. <para> When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. </para><para> You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>. </para><para> To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. </para><para> Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html">Amazon Elastic Block Store</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SnapshotCmdlet.Description"> <summary> <para> <para>A description for the snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SnapshotCmdlet.VolumeId"> <summary> <para> <para>The ID of the EBS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SnapshotCmdlet.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.EC2.NewEC2SpotDatafeedSubscriptionCmdlet"> <summary> Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SpotDatafeedSubscriptionCmdlet.Bucket"> <summary> <para> <para>The Amazon S3 bucket in which to store the Spot instance data feed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SpotDatafeedSubscriptionCmdlet.Prefix"> <summary> <para> <para>A prefix for the data feed file names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SpotDatafeedSubscriptionCmdlet.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.EC2.NewEC2SubnetCmdlet"> <summary> Creates a subnet in an existing VPC. <para> When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). </para><important><para> AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. </para></important><para> If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. </para><para> If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. </para><para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SubnetCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone for the subnet.</para><para>Default: Amazon EC2 selects one for you (recommended).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SubnetCmdlet.CidrBlock"> <summary> <para> <para>The network range for the subnet, in CIDR notation. For example, <code>10.0.0.0/24</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SubnetCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2SubnetCmdlet.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.EC2.NewEC2TagCmdlet"> <summary> Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2TagCmdlet.Resource"> <summary> <para> <para>The IDs of one or more resources to tag. For example, ami-1a2b3c4d.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2TagCmdlet.Tag"> <summary> <para> <para>One or more tags. The <code>value</code> parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2TagCmdlet.PassThru"> <summary> Returns the collection of Tag objects that were created. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2TagCmdlet.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.EC2.NewEC2VolumeCmdlet"> <summary> Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. <para> You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. </para><para> You can create encrypted volumes with the <code>Encrypted</code> parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html">Creating or Restoring an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VolumeCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone in which to create the volume. Use <a>DescribeAvailabilityZones</a> to list the Availability Zones that are currently available to you.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VolumeCmdlet.Encrypted"> <summary> <para> <para>Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VolumeCmdlet.Iops"> <summary> <para> <para>Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.</para><para>Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VolumeCmdlet.KmsKeyId"> <summary> <para> <para>The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the <code>arn:aws:kms</code> namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the <code>key</code> namespace, and then the CMK ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VolumeCmdlet.Size"> <summary> <para> <para>The size of the volume, in GiBs.</para><para>Constraints: <code>1-1024</code> for <code>standard</code> volumes, <code>1-16384</code> for <code>gp2</code> volumes, and <code>4-16384</code> for <code>io1</code> volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.</para><para>Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VolumeCmdlet.SnapshotId"> <summary> <para> <para>The snapshot from which to create the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VolumeCmdlet.VolumeType"> <summary> <para> <para>The volume type. This can be <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, or <code>standard</code> for Magnetic volumes.</para><para>Default: <code>standard</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VolumeCmdlet.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.EC2.NewEC2VpcCmdlet"> <summary> Creates a VPC with the specified CIDR block. <para> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para><para> By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcCmdlet.CidrBlock"> <summary> <para> <para>The network range for the VPC, in CIDR notation. For example, <code>10.0.0.0/16</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcCmdlet.InstanceTenancy"> <summary> <para> <para>The supported tenancy options for instances launched into the VPC. A value of <code>default</code> means that instances can be launched with any tenancy; a value of <code>dedicated</code> means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.</para><para>Default: <code>default</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcCmdlet.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.EC2.NewEC2VpcEndpointCmdlet"> <summary> Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. <para> Currently, only endpoints to Amazon S3 are supported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcEndpointCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">How to Ensure Idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcEndpointCmdlet.PolicyDocument"> <summary> <para> <para>A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcEndpointCmdlet.RouteTableId"> <summary> <para> <para>One or more route table IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcEndpointCmdlet.ServiceName"> <summary> <para> <para>The AWS service name, in the form <code>com.amazonaws.<i>region</i>.<i>service</i></code>. To get a list of available services, use the <a>DescribeVpcEndpointServices</a> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcEndpointCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC in which the endpoint will be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcEndpointCmdlet.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.EC2.NewEC2VpcPeeringConnectionCmdlet"> <summary> Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks. <para> The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. </para><para> A <code>CreateVpcPeeringConnection</code> request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of <code>failed</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcPeeringConnectionCmdlet.PeerOwnerId"> <summary> <para> <para>The AWS account ID of the owner of the peer VPC.</para><para>Default: Your AWS account ID</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcPeeringConnectionCmdlet.PeerVpcId"> <summary> <para> <para>The ID of the VPC with which you are creating the VPC peering connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcPeeringConnectionCmdlet.VpcId"> <summary> <para> <para>The ID of the requester VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpcPeeringConnectionCmdlet.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.EC2.NewEC2VpnConnectionCmdlet"> <summary> Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is <code>ipsec.1</code>. <para> The response includes information that you need to give to your network administrator to configure your customer gateway. </para><important><para> We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </para></important><para> If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. </para><para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionCmdlet.CustomerGatewayId"> <summary> <para> <para>The ID of the customer gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionCmdlet.Options_StaticRoutesOnly"> <summary> <para> <para>Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionCmdlet.Type"> <summary> <para> <para>The type of VPN connection (<code>ipsec.1</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionCmdlet.VpnGatewayId"> <summary> <para> <para>The ID of the virtual private gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionCmdlet.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.EC2.NewEC2VpnConnectionRouteCmdlet"> <summary> Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionRouteCmdlet.DestinationCidrBlock"> <summary> <para> <para>The CIDR block associated with the local subnet of the customer network.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionRouteCmdlet.VpnConnectionId"> <summary> <para> <para>The ID of the VPN connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionRouteCmdlet.PassThru"> <summary> Returns the value passed to the VpnConnectionId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnConnectionRouteCmdlet.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.EC2.NewEC2VpnGatewayCmdlet"> <summary> Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnGatewayCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone for the virtual private gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnGatewayCmdlet.Type"> <summary> <para> <para>The type of VPN connection this virtual private gateway supports.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.NewEC2VpnGatewayCmdlet.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.EC2.RegisterEC2AddressCmdlet"> <summary> Associates an Elastic IP address with an instance or a network interface. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para><para> [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. </para><para> [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. </para><para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2AddressCmdlet.AllocationId"> <summary> <para> <para>[EC2-VPC] The allocation ID. This is required for EC2-VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2AddressCmdlet.AllowReassociation"> <summary> <para> <para>[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2AddressCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2AddressCmdlet.NetworkInterfaceId"> <summary> <para> <para>[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2AddressCmdlet.PrivateIpAddress"> <summary> <para> <para>[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2AddressCmdlet.PublicIp"> <summary> <para> <para>The Elastic IP address. This is required for EC2-Classic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2AddressCmdlet.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.EC2.RegisterEC2DhcpOptionCmdlet"> <summary> Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. <para> After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2DhcpOptionCmdlet.DhcpOptionsId"> <summary> <para> <para>The ID of the DHCP options set, or <code>default</code> to associate no DHCP options with the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2DhcpOptionCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2DhcpOptionCmdlet.PassThru"> <summary> Returns the value passed to the VpcId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2DhcpOptionCmdlet.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.EC2.RegisterEC2ImageCmdlet"> <summary> Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <note><para> For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself. </para></note><para> You can also use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html">Launching an Instance from a Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para><important><para> Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 <code>billingProduct</code> code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. </para><para> Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI. </para><para> To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see <a>CreateImage</a>. </para></important><para> If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. </para><note><para> You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.Architecture"> <summary> <para> <para>The architecture of the AMI.</para><para>Default: For Amazon EBS-backed AMIs, <code>i386</code>. For instance store-backed AMIs, the architecture specified in the manifest file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.BlockDeviceMapping"> <summary> <para> <para>One or more block device mapping entries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.Description"> <summary> <para> <para>A description for your AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.ImageLocation"> <summary> <para> <para>The full path to your AMI manifest in Amazon S3 storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.KernelId"> <summary> <para> <para>The ID of the kernel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.Name"> <summary> <para> <para>A name for your AMI.</para><para>Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.RamdiskId"> <summary> <para> <para>The ID of the RAM disk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.RootDeviceName"> <summary> <para> <para>The name of the root device (for example, <code>/dev/sda1</code>, or <code>/dev/xvda</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.SriovNetSupport"> <summary> <para> <para>Set to <code>simple</code> to enable enhanced networking for the AMI and any instances that you launch from the AMI.</para><para>There is no way to disable enhanced networking at this time.</para><para>This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.VirtualizationType"> <summary> <para> <para>The type of virtualization.</para><para>Default: <code>paravirtual</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2ImageCmdlet.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.EC2.RegisterEC2PrivateIpAddressCmdlet"> <summary> Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP addresses, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> AssignPrivateIpAddresses is available only in EC2-VPC. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2PrivateIpAddressCmdlet.AllowReassignment"> <summary> <para> <para>Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2PrivateIpAddressCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2PrivateIpAddressCmdlet.PrivateIpAddress"> <summary> <para> <para>One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.</para><para>If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2PrivateIpAddressCmdlet.SecondaryPrivateIpAddressCount"> <summary> <para> <para>The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2PrivateIpAddressCmdlet.PassThru"> <summary> Returns the value passed to the NetworkInterfaceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2PrivateIpAddressCmdlet.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.EC2.RegisterEC2RouteTableCmdlet"> <summary> Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2RouteTableCmdlet.RouteTableId"> <summary> <para> <para>The ID of the route table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2RouteTableCmdlet.SubnetId"> <summary> <para> <para>The ID of the subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RegisterEC2RouteTableCmdlet.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.EC2.RemoveEC2AddressCmdlet"> <summary> Releases the specified Elastic IP address. <para> After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another AWS account. </para><para> [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>. </para><para> [Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2AddressCmdlet.AllocationId"> <summary> <para> <para>[EC2-VPC] The allocation ID. Required for EC2-VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2AddressCmdlet.PublicIp"> <summary> <para> <para>[EC2-Classic] The Elastic IP address. Required for EC2-Classic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2AddressCmdlet.PassThru"> <summary> Returns the value passed to the PublicIp parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2AddressCmdlet.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.EC2.RemoveEC2CustomerGatewayCmdlet"> <summary> Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2CustomerGatewayCmdlet.CustomerGatewayId"> <summary> <para> <para>The ID of the customer gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2CustomerGatewayCmdlet.PassThru"> <summary> Returns the value passed to the CustomerGatewayId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2CustomerGatewayCmdlet.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.EC2.RemoveEC2DhcpOptionCmdlet"> <summary> Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2DhcpOptionCmdlet.DhcpOptionsId"> <summary> <para> <para>The ID of the DHCP options set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2DhcpOptionCmdlet.PassThru"> <summary> Returns the value passed to the DhcpOptionsId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2DhcpOptionCmdlet.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.EC2.RemoveEC2FlowLogsCmdlet"> <summary> Deletes one or more flow logs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2FlowLogsCmdlet.FlowLogId"> <summary> <para> <para>One or more flow log IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2FlowLogsCmdlet.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.EC2.RemoveEC2InternetGatewayCmdlet"> <summary> Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2InternetGatewayCmdlet.InternetGatewayId"> <summary> <para> <para>The ID of the Internet gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2InternetGatewayCmdlet.PassThru"> <summary> Returns the value passed to the InternetGatewayId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2InternetGatewayCmdlet.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.EC2.RemoveEC2KeyPairCmdlet"> <summary> Deletes the specified key pair, by removing the public key from Amazon EC2. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2KeyPairCmdlet.KeyName"> <summary> <para> <para>The name of the key pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2KeyPairCmdlet.PassThru"> <summary> Returns the value passed to the KeyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2KeyPairCmdlet.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.EC2.RemoveEC2NetworkAclCmdlet"> <summary> Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkAclCmdlet.NetworkAclId"> <summary> <para> <para>The ID of the network ACL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkAclCmdlet.PassThru"> <summary> Returns the value passed to the NetworkAclId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkAclCmdlet.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.EC2.RemoveEC2NetworkAclEntryCmdlet"> <summary> Deletes the specified ingress or egress entry (rule) from the specified network ACL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkAclEntryCmdlet.Egress"> <summary> <para> <para>Indicates whether the rule is an egress rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkAclEntryCmdlet.NetworkAclId"> <summary> <para> <para>The ID of the network ACL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkAclEntryCmdlet.RuleNumber"> <summary> <para> <para>The rule number of the entry to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkAclEntryCmdlet.PassThru"> <summary> Returns the value passed to the NetworkAclId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkAclEntryCmdlet.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.EC2.RemoveEC2NetworkInterfaceCmdlet"> <summary> Deletes the specified network interface. You must detach the network interface before you can delete it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkInterfaceCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkInterfaceCmdlet.PassThru"> <summary> Returns the value passed to the NetworkInterfaceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2NetworkInterfaceCmdlet.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.EC2.RemoveEC2PlacementGroupCmdlet"> <summary> Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2PlacementGroupCmdlet.GroupName"> <summary> <para> <para>The name of the placement group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2PlacementGroupCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2PlacementGroupCmdlet.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.EC2.RemoveEC2RouteCmdlet"> <summary> Deletes the specified route from the specified route table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2RouteCmdlet.DestinationCidrBlock"> <summary> <para> <para>The CIDR range for the route. The value you specify must match the CIDR for the route exactly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2RouteCmdlet.RouteTableId"> <summary> <para> <para>The ID of the route table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2RouteCmdlet.PassThru"> <summary> Returns the value passed to the RouteTableId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2RouteCmdlet.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.EC2.RemoveEC2RouteTableCmdlet"> <summary> Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2RouteTableCmdlet.RouteTableId"> <summary> <para> <para>The ID of the route table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2RouteTableCmdlet.PassThru"> <summary> Returns the value passed to the RouteTableId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2RouteTableCmdlet.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.EC2.RemoveEC2SecurityGroupCmdlet"> <summary> Deletes a security group. <para> If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SecurityGroupCmdlet.GroupId"> <summary> <para> <para>The ID of the security group. Required for a nondefault VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SecurityGroupCmdlet.GroupName"> <summary> <para> <para>[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SecurityGroupCmdlet.PassThru"> <summary> Returns the value passed to the GroupId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SecurityGroupCmdlet.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.EC2.RemoveEC2SnapshotCmdlet"> <summary> Deletes the specified snapshot. <para> When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. </para><para> You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html">Deleting an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SnapshotCmdlet.SnapshotId"> <summary> <para> <para>The ID of the EBS snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SnapshotCmdlet.PassThru"> <summary> Returns the value passed to the SnapshotId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SnapshotCmdlet.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.EC2.RemoveEC2SpotDatafeedSubscriptionCmdlet"> <summary> Deletes the data feed for Spot instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SpotDatafeedSubscriptionCmdlet.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.EC2.RemoveEC2SubnetCmdlet"> <summary> Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SubnetCmdlet.SubnetId"> <summary> <para> <para>The ID of the subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SubnetCmdlet.PassThru"> <summary> Returns the value passed to the SubnetId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2SubnetCmdlet.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.EC2.RemoveEC2TagCmdlet"> <summary> Deletes the specified set of tags from the specified set of resources. This call is designed to follow a <code>DescribeTags</code> request. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2TagCmdlet.Resource"> <summary> <para> <para>The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2TagCmdlet.Tag"> <summary> <para> <para>One or more tags to delete. If you omit the <code>value</code> parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2TagCmdlet.PassThru"> <summary> Returns the collection of Tag objects that were deleted. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2TagCmdlet.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.EC2.RemoveEC2VolumeCmdlet"> <summary> Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance). <note><para> The volume may remain in the <code>deleting</code> state for several minutes. </para></note><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html">Deleting an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VolumeCmdlet.VolumeId"> <summary> <para> <para>The ID of the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VolumeCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VolumeCmdlet.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.EC2.RemoveEC2VpcCmdlet"> <summary> Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpcCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpcCmdlet.PassThru"> <summary> Returns the value passed to the VpcId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpcCmdlet.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.EC2.RemoveEC2VpcEndpointCmdlet"> <summary> Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpcEndpointCmdlet.VpcEndpointId"> <summary> <para> <para>One or more endpoint IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpcEndpointCmdlet.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.EC2.RemoveEC2VpcPeeringConnectionCmdlet"> <summary> Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the <code>active</code> state. The owner of the requester VPC can delete a VPC peering connection in the <code>pending-acceptance</code> state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpcPeeringConnectionCmdlet.VpcPeeringConnectionId"> <summary> <para> <para>The ID of the VPC peering connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpcPeeringConnectionCmdlet.PassThru"> <summary> Returns the value passed to the VpcPeeringConnectionId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpcPeeringConnectionCmdlet.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.EC2.RemoveEC2VpnConnectionCmdlet"> <summary> Deletes the specified VPN connection. <para> If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnConnectionCmdlet.VpnConnectionId"> <summary> <para> <para>The ID of the VPN connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnConnectionCmdlet.PassThru"> <summary> Returns the value passed to the VpnConnectionId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnConnectionCmdlet.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.EC2.RemoveEC2VpnConnectionRouteCmdlet"> <summary> Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnConnectionRouteCmdlet.DestinationCidrBlock"> <summary> <para> <para>The CIDR block associated with the local subnet of the customer network.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnConnectionRouteCmdlet.VpnConnectionId"> <summary> <para> <para>The ID of the VPN connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnConnectionRouteCmdlet.PassThru"> <summary> Returns the value passed to the VpnConnectionId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnConnectionRouteCmdlet.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.EC2.RemoveEC2VpnGatewayCmdlet"> <summary> Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnGatewayCmdlet.VpnGatewayId"> <summary> <para> <para>The ID of the virtual private gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnGatewayCmdlet.PassThru"> <summary> Returns the value passed to the VpnGatewayId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RemoveEC2VpnGatewayCmdlet.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.EC2.RequestEC2SpotFleetCmdlet"> <summary> Creates a Spot fleet request. <para> You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. </para><para> By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. </para><para> Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html">Spot Fleet Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_AllocationStrategy"> <summary> <para> <para>Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is <code>lowestPrice</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_ExcessCapacityTerminationPolicy"> <summary> <para> <para>Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_IamFleetRole"> <summary> <para> <para>Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using <a>CancelSpotFleetRequests</a> or when the Spot fleet request expires, if you set <code>terminateInstancesWithExpiration</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_LaunchSpecification"> <summary> <para> <para>Information about the launch specifications for the Spot fleet request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_SpotPrice"> <summary> <para> <para>The bid price per unit hour.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_TargetCapacity"> <summary> <para> <para>The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_TerminateInstancesWithExpiration"> <summary> <para> <para>Indicates whether running Spot instances should be terminated when the Spot fleet request expires.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_ValidFrom"> <summary> <para> <para>The start date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). The default is to start fulfilling the request immediately.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.SpotFleetRequestConfig_ValidUntil"> <summary> <para> <para>The end date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). At this point, no new Spot instance requests are placed or enabled to fulfill the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotFleetCmdlet.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.EC2.RequestEC2SpotInstanceCmdlet"> <summary> Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_AddressingType"> <summary> <para> <para>Deprecated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_AllSecurityGroup"> <summary> <para> <para>One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.IamInstanceProfile_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the instance profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.Placement_AvailabilityZone"> <summary> <para> <para>The Availability Zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.AvailabilityZoneGroup"> <summary> <para> <para>The user-specified name for a logical grouping of bids.</para><para>When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.</para><para>If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.</para><para>Default: Instances are launched in any available Availability Zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_BlockDeviceMapping"> <summary> <para> <para>One or more block device mapping entries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.BlockDurationMinute"> <summary> <para> <para>The required duration for the Spot instances, in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).</para><para>The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.</para><para>Note that you can't specify an Availability Zone group or a launch group if you specify a required duration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_EbsOptimized"> <summary> <para> <para>Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.Placement_GroupName"> <summary> <para> <para>The name of the placement group (for cluster instances).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_ImageId"> <summary> <para> <para>The ID of the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.InstanceCount"> <summary> <para> <para>The maximum number of Spot instances to launch.</para><para>Default: 1</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_InstanceType"> <summary> <para> <para>The instance type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_KernelId"> <summary> <para> <para>The ID of the kernel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_KeyName"> <summary> <para> <para>The name of the key pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchGroup"> <summary> <para> <para>The instance launch group. Launch groups are Spot instances that launch together and terminate together.</para><para>Default: Instances are launched and terminated individually</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_MonitoringEnabled"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.IamInstanceProfile_Name"> <summary> <para> <para>The name of the instance profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_NetworkInterface"> <summary> <para> <para>One or more network interfaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_RamdiskId"> <summary> <para> <para>The ID of the RAM disk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_SecurityGroup"> <summary> <para> <para>One or more security group names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.SpotPrice"> <summary> <para> <para>The maximum hourly price (bid) for any Spot instance launched to fulfill the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_SubnetId"> <summary> <para> <para>The ID of the subnet in which to launch the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.Type"> <summary> <para> <para>The Spot instance request type.</para><para>Default: <code>one-time</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.LaunchSpecification_UserData"> <summary> <para> <para>The Base64-encoded MIME user data to make available to the instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.ValidFrom"> <summary> <para> <para>The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.</para><para>Default: The request is effective indefinitely.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.ValidUntil"> <summary> <para> <para>The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.</para><para>Default: The request is effective indefinitely.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RequestEC2SpotInstanceCmdlet.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.EC2.ResetEC2ImageAttributeCmdlet"> <summary> Resets an attribute of an AMI to its default value. <note><para> The productCodes attribute can't be reset. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2ImageAttributeCmdlet.Attribute"> <summary> <para> <para>The attribute to reset (currently you can only reset the launch permission attribute).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2ImageAttributeCmdlet.ImageId"> <summary> <para> <para>The ID of the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2ImageAttributeCmdlet.PassThru"> <summary> Returns the value passed to the ImageId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2ImageAttributeCmdlet.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.EC2.ResetEC2InstanceAttributeCmdlet"> <summary> Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>SourceDestCheck</code>, the instance can be either running or stopped. <para> The <code>SourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2InstanceAttributeCmdlet.Attribute"> <summary> <para> <para>The attribute to reset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2InstanceAttributeCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2InstanceAttributeCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2InstanceAttributeCmdlet.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.EC2.ResetEC2NetworkInterfaceAttributeCmdlet"> <summary> Resets a network interface attribute. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2NetworkInterfaceAttributeCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2NetworkInterfaceAttributeCmdlet.SourceDestCheck"> <summary> <para> <para>The source/destination checking attribute. Resets the value to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2NetworkInterfaceAttributeCmdlet.PassThru"> <summary> Returns the value passed to the NetworkInterfaceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2NetworkInterfaceAttributeCmdlet.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.EC2.ResetEC2SnapshotAttributeCmdlet"> <summary> Resets permission settings for the specified snapshot. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2SnapshotAttributeCmdlet.Attribute"> <summary> <para> <para>The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2SnapshotAttributeCmdlet.SnapshotId"> <summary> <para> <para>The ID of the snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2SnapshotAttributeCmdlet.PassThru"> <summary> Returns the value passed to the SnapshotId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.ResetEC2SnapshotAttributeCmdlet.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.EC2.RestartEC2InstanceCmdlet"> <summary> Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. <para> If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. </para><para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Getting Console Output and Rebooting Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RestartEC2InstanceCmdlet.InstanceId"> <summary> <para> <para>One or more instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RestartEC2InstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RestartEC2InstanceCmdlet.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.EC2.RestoreEC2AddressToClassicCmdlet"> <summary> Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RestoreEC2AddressToClassicCmdlet.PublicIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RestoreEC2AddressToClassicCmdlet.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.EC2.RevokeEC2SecurityGroupEgressCmdlet"> <summary> Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para><para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupEgressCmdlet.GroupId"> <summary> <para> <para>The ID of the security group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupEgressCmdlet.IpPermission"> <summary> <para> <para>A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupEgressCmdlet.PassThru"> <summary> Returns the value passed to the GroupId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupEgressCmdlet.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.EC2.RevokeEC2SecurityGroupIngressCmdlet"> <summary> Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para><para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupIngressCmdlet.GroupId"> <summary> <para> <para>The ID of the security group. Required for a security group in a nondefault VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupIngressCmdlet.GroupName"> <summary> <para> <para>[EC2-Classic, default VPC] The name of the security group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupIngressCmdlet.IpPermission"> <summary> <para> <para>A set of IP permissions. You can't specify a source security group and a CIDR IP address range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupIngressCmdlet.PassThru"> <summary> Returns the value passed to the GroupId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.RevokeEC2SecurityGroupIngressCmdlet.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.EC2.SendEC2InstanceStatusCmdlet"> <summary> Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. <para> Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SendEC2InstanceStatusCmdlet.Description"> <summary> <para> <para>Descriptive text about the health state of your instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SendEC2InstanceStatusCmdlet.EndTime"> <summary> <para> <para>The time at which the reported instance health state ended.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SendEC2InstanceStatusCmdlet.Instance"> <summary> <para> <para>One or more instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SendEC2InstanceStatusCmdlet.ReasonCode"> <summary> <para> <para>One or more reason codes that describes the health state of your instance.</para><ul><li><para><code>instance-stuck-in-state</code>: My instance is stuck in a state.</para></li><li><para><code>unresponsive</code>: My instance is unresponsive.</para></li><li><para><code>not-accepting-credentials</code>: My instance is not accepting my credentials.</para></li><li><para><code>password-not-available</code>: A password is not available for my instance.</para></li><li><para><code>performance-network</code>: My instance is experiencing performance problems which I believe are network related.</para></li><li><para><code>performance-instance-store</code>: My instance is experiencing performance problems which I believe are related to the instance stores.</para></li><li><para><code>performance-ebs-volume</code>: My instance is experiencing performance problems which I believe are related to an EBS volume.</para></li><li><para><code>performance-other</code>: My instance is experiencing performance problems.</para></li><li><para><code>other</code>: [explain using the description parameter]</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SendEC2InstanceStatusCmdlet.StartTime"> <summary> <para> <para>The time at which the reported instance health state began.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SendEC2InstanceStatusCmdlet.Status"> <summary> <para> <para>The status of all instances listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SendEC2InstanceStatusCmdlet.PassThru"> <summary> Returns the value passed to the Instance parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SendEC2InstanceStatusCmdlet.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.EC2.SetEC2NetworkAclAssociationCmdlet"> <summary> Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclAssociationCmdlet.AssociationId"> <summary> <para> <para>The ID of the current association between the original network ACL and the subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclAssociationCmdlet.NetworkAclId"> <summary> <para> <para>The ID of the new network ACL to associate with the subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclAssociationCmdlet.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.EC2.SetEC2NetworkAclEntryCmdlet"> <summary> Replaces an entry (rule) in a network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.CidrBlock"> <summary> <para> <para>The network range to allow or deny, in CIDR notation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.IcmpTypeCode_Code"> <summary> <para> <para>The ICMP type. A value of -1 means all types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.Egress"> <summary> <para> <para>Indicates whether to replace the egress rule.</para><para>Default: If no value is specified, we replace the ingress rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.PortRange_From"> <summary> <para> <para>The first port in the range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.NetworkAclId"> <summary> <para> <para>The ID of the ACL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.Protocol"> <summary> <para> <para>The IP protocol. You can specify <code>all</code> or <code>-1</code> to mean all protocols.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.RuleAction"> <summary> <para> <para>Indicates whether to allow or deny the traffic that matches the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.RuleNumber"> <summary> <para> <para>The rule number of the entry to replace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.PortRange_To"> <summary> <para> <para>The last port in the range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.IcmpTypeCode_Type"> <summary> <para> <para>The ICMP code. A value of -1 means all codes for the specified ICMP type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.PassThru"> <summary> Returns the value passed to the NetworkAclId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2NetworkAclEntryCmdlet.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.EC2.SetEC2RouteCmdlet"> <summary> Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteCmdlet.DestinationCidrBlock"> <summary> <para> <para>The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteCmdlet.GatewayId"> <summary> <para> <para>The ID of an Internet gateway or virtual private gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteCmdlet.InstanceId"> <summary> <para> <para>The ID of a NAT instance in your VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of a network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteCmdlet.RouteTableId"> <summary> <para> <para>The ID of the route table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteCmdlet.VpcPeeringConnectionId"> <summary> <para> <para>The ID of a VPC peering connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteCmdlet.PassThru"> <summary> Returns the value passed to the RouteTableId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteCmdlet.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.EC2.SetEC2RouteTableAssociationCmdlet"> <summary> Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. <para> You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteTableAssociationCmdlet.AssociationId"> <summary> <para> <para>The association ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteTableAssociationCmdlet.RouteTableId"> <summary> <para> <para>The ID of the new route table to associate with the subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.SetEC2RouteTableAssociationCmdlet.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.EC2.StartEC2InstanceCmdlet"> <summary> Starts an Amazon EBS-backed AMI that you've previously stopped. <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. </para><para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para><para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para><para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stopping Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StartEC2InstanceCmdlet.AdditionalInfo"> <summary> <para> <para>Reserved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StartEC2InstanceCmdlet.InstanceId"> <summary> <para> <para>One or more instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StartEC2InstanceCmdlet.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.EC2.StartEC2InstanceMonitoringCmdlet"> <summary> Enables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StartEC2InstanceMonitoringCmdlet.InstanceId"> <summary> <para> <para>One or more instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StartEC2InstanceMonitoringCmdlet.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.EC2.StopEC2BundleTaskCmdlet"> <summary> Cancels a bundling operation for an instance store-backed Windows instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2BundleTaskCmdlet.BundleId"> <summary> <para> <para>The ID of the bundle task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2BundleTaskCmdlet.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.EC2.StopEC2ExportTaskCmdlet"> <summary> Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2ExportTaskCmdlet.ExportTaskId"> <summary> <para> <para>The ID of the export task. This is the ID returned by <code>CreateInstanceExportTask</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2ExportTaskCmdlet.PassThru"> <summary> Returns the value passed to the ExportTaskId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2ExportTaskCmdlet.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.EC2.StopEC2ImportTaskCmdlet"> <summary> Cancels an in-process import virtual machine or import snapshot task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2ImportTaskCmdlet.CancelReason"> <summary> <para> <para>The reason for canceling the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2ImportTaskCmdlet.ImportTaskId"> <summary> <para> <para>The ID of the import image or import snapshot task to be canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2ImportTaskCmdlet.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.EC2.StopEC2InstanceMonitoringCmdlet"> <summary> Disables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2InstanceMonitoringCmdlet.InstanceId"> <summary> <para> <para>One or more instance IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2InstanceMonitoringCmdlet.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.EC2.StopEC2ReservedInstancesListingCmdlet"> <summary> Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2ReservedInstancesListingCmdlet.ReservedInstancesListingId"> <summary> <para> <para>The ID of the Reserved Instance listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2ReservedInstancesListingCmdlet.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.EC2.StopEC2SpotFleetRequestCmdlet"> <summary> Cancels the specified Spot fleet requests. <para> After you cancel a Spot fleet request, the Spot fleet launches no new Spot instances. You must specify whether the Spot fleet should also terminate its Spot instances. If you terminate the instances, the Spot fleet request enters the <code>cancelled_terminating</code> state. Otherwise, the Spot fleet request enters the <code>cancelled_running</code> state and the instances continue to run until they are interrupted or you terminate them manually. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2SpotFleetRequestCmdlet.SpotFleetRequestId"> <summary> <para> <para>The IDs of the Spot fleet requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2SpotFleetRequestCmdlet.TerminateInstance"> <summary> <para> <para>Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2SpotFleetRequestCmdlet.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.EC2.StopEC2SpotInstanceRequestCmdlet"> <summary> Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <important><para> Canceling a Spot instance request does not terminate running Spot instances associated with the request. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2SpotInstanceRequestCmdlet.SpotInstanceRequestId"> <summary> <para> <para>One or more Spot instance request IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.StopEC2SpotInstanceRequestCmdlet.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.EC2.UnregisterEC2AddressCmdlet"> <summary> Disassociates an Elastic IP address from the instance or network interface it's associated with. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para><para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2AddressCmdlet.AssociationId"> <summary> <para> <para>[EC2-VPC] The association ID. Required for EC2-VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2AddressCmdlet.PublicIp"> <summary> <para> <para>[EC2-Classic] The Elastic IP address. Required for EC2-Classic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2AddressCmdlet.PassThru"> <summary> Returns the value passed to the PublicIp parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2AddressCmdlet.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.EC2.UnregisterEC2ImageCmdlet"> <summary> Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances. <para> This command does not delete the AMI. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2ImageCmdlet.ImageId"> <summary> <para> <para>The ID of the AMI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2ImageCmdlet.PassThru"> <summary> Returns the value passed to the ImageId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2ImageCmdlet.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.EC2.UnregisterEC2PrivateIpAddressCmdlet"> <summary> Unassigns one or more secondary private IP addresses from a network interface. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2PrivateIpAddressCmdlet.NetworkInterfaceId"> <summary> <para> <para>The ID of the network interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2PrivateIpAddressCmdlet.PrivateIpAddress"> <summary> <para> <para>The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2PrivateIpAddressCmdlet.PassThru"> <summary> Returns the secondary private IP addresses. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2PrivateIpAddressCmdlet.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.EC2.UnregisterEC2RouteTableCmdlet"> <summary> Disassociates a subnet from a route table. <para> After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2RouteTableCmdlet.AssociationId"> <summary> <para> <para>The association ID representing the current association between the route table and subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2RouteTableCmdlet.PassThru"> <summary> Returns the value passed to the AssociationId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC2.UnregisterEC2RouteTableCmdlet.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.ECS.GetECSClusterDetailCmdlet"> <summary> Describes one or more of your clusters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSClusterDetailCmdlet.Cluster"> <summary> <para> <para>A space-separated list of cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSClustersCmdlet"> <summary> Returns a list of existing clusters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSClustersCmdlet.MaxResult"> <summary> <para> <para>The maximum number of cluster results returned by <code>ListClusters</code> in paginated output. When this parameter is used, <code>ListClusters</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListClusters</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListClusters</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSClustersCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListClusters</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSClusterServiceCmdlet"> <summary> Lists the services that are running in a specified cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSClusterServiceCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSClusterServiceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of container instance results returned by <code>ListServices</code> in paginated output. When this parameter is used, <code>ListServices</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListServices</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListServices</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSClusterServiceCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListServices</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSContainerInstanceDetailCmdlet"> <summary> Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSContainerInstanceDetailCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSContainerInstanceDetailCmdlet.ContainerInstance"> <summary> <para> <para>A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSContainerInstancesCmdlet"> <summary> Returns a list of container instances in a specified cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSContainerInstancesCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSContainerInstancesCmdlet.MaxResult"> <summary> <para> <para>The maximum number of container instance results returned by <code>ListContainerInstances</code> in paginated output. When this parameter is used, <code>ListContainerInstances</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListContainerInstances</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListContainerInstances</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSContainerInstancesCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListContainerInstances</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSServiceCmdlet"> <summary> Describes the specified services running in your cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSServiceCmdlet.Cluster"> <summary> <para> <para>The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSServiceCmdlet.Service"> <summary> <para> <para>A list of services to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionDetailCmdlet"> <summary> Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family. <note><para> You can only describe <code>INACTIVE</code> task definitions while an active task or service references them. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionDetailCmdlet.TaskDefinition"> <summary> <para> <para>The <code>family</code> for the latest <code>ACTIVE</code> revision, <code>family</code> and <code>revision</code> (<code>family:revision</code>) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionFamiliesCmdlet"> <summary> Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any <code>ACTIVE</code> task definitions). You can filter the results with the <code>familyPrefix</code> parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionFamiliesCmdlet.FamilyPrefix"> <summary> <para> <para>The <code>familyPrefix</code> is a string that is used to filter the results of <code>ListTaskDefinitionFamilies</code>. If you specify a <code>familyPrefix</code>, only task definition family names that begin with the <code>familyPrefix</code> string are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionFamiliesCmdlet.MaxResult"> <summary> <para> <para>The maximum number of task definition family results returned by <code>ListTaskDefinitionFamilies</code> in paginated output. When this parameter is used, <code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTaskDefinitionFamilies</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTaskDefinitionFamilies</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionFamiliesCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListTaskDefinitionFamilies</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionsCmdlet"> <summary> Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionsCmdlet.FamilyPrefix"> <summary> <para> <para>The full family name with which to filter the <code>ListTaskDefinitions</code> results. Specifying a <code>familyPrefix</code> limits the listed task definitions to task definition revisions that belong to that family.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionsCmdlet.Sort"> <summary> <para> <para>The order in which to sort the results. Valid values are <code>ASC</code> and <code>DESC</code>. By default (<code>ASC</code>), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to <code>DESC</code> reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionsCmdlet.Status"> <summary> <para> <para>The task definition status with which to filter the <code>ListTaskDefinitions</code> results. By default, only <code>ACTIVE</code> task definitions are listed. By setting this parameter to <code>INACTIVE</code>, you can view task definitions that are <code>INACTIVE</code> as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the <code>status</code> value constant in each subsequent request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionsCmdlet.MaxResult"> <summary> <para> <para>The maximum number of task definition results returned by <code>ListTaskDefinitions</code> in paginated output. When this parameter is used, <code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTaskDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTaskDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDefinitionsCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListTaskDefinitions</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDetailCmdlet"> <summary> Describes a specified task or tasks. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDetailCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTaskDetailCmdlet.Task"> <summary> <para> <para>A space-separated list of task IDs or full Amazon Resource Name (ARN) entries.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet"> <summary> Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the <code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code> parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet.ContainerInstance"> <summary> <para> <para>The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the <code>ListTasks</code> results. Specifying a <code>containerInstance</code> limits the results to tasks that belong to that container instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet.DesiredStatus"> <summary> <para> <para>The task status with which to filter the <code>ListTasks</code> results. Specifying a <code>desiredStatus</code> of <code>STOPPED</code> limits the results to tasks that are in the <code>STOPPED</code> status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is <code>RUNNING</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet.Family"> <summary> <para> <para>The name of the family with which to filter the <code>ListTasks</code> results. Specifying a <code>family</code> limits the results to tasks that belong to that family.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet.ServiceName"> <summary> <para> <para>The name of the service with which to filter the <code>ListTasks</code> results. Specifying a <code>serviceName</code> limits the results to tasks that belong to that service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet.StartedBy"> <summary> <para> <para>The <code>startedBy</code> value with which to filter the task results. Specifying a <code>startedBy</code> value limits the results to tasks that were started with that value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet.MaxResult"> <summary> <para> <para>The maximum number of task results returned by <code>ListTasks</code> in paginated output. When this parameter is used, <code>ListTasks</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTasks</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTasks</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.GetECSTasksCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListTasks</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECS.NewECSClusterCmdlet"> <summary> Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSClusterCmdlet.ClusterName"> <summary> <para> <para>The name of your cluster. If you do not specify a name for your cluster, you create a cluster named <code>default</code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSClusterCmdlet.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.ECS.NewECSServiceCmdlet"> <summary> Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another instantiation of the task in the specified cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSServiceCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSServiceCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSServiceCmdlet.DesiredCount"> <summary> <para> <para>The number of instantiations of the specified task definition to place and keep running on your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSServiceCmdlet.LoadBalancer"> <summary> <para> <para>A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSServiceCmdlet.Role"> <summary> <para> <para>The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSServiceCmdlet.ServiceName"> <summary> <para> <para>The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSServiceCmdlet.TaskDefinition"> <summary> <para> <para>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSServiceCmdlet.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.ECS.NewECSTaskCmdlet"> <summary> Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use <code>StartTask</code> instead. <important><para> The <code>count</code> parameter is limited to 10 tasks per call. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSTaskCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSTaskCmdlet.Overrides_ContainerOverride"> <summary> <para> <para>One or more container overrides sent to a task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSTaskCmdlet.Count"> <summary> <para> <para>The number of instantiations of the specified task to place on your cluster.</para><important><para>The <code>count</code> parameter is limited to 10 tasks per call.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSTaskCmdlet.StartedBy"> <summary> <para> <para>An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a>ListTasks</a> call with the <code>startedBy</code> value.</para><para>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSTaskCmdlet.TaskDefinition"> <summary> <para> <para>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to run. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.NewECSTaskCmdlet.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.ECS.RegisterECSTaskDefinitionCmdlet"> <summary> Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RegisterECSTaskDefinitionCmdlet.ContainerDefinition"> <summary> <para> <para>A list of container definitions in JSON format that describe the different containers that make up your task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RegisterECSTaskDefinitionCmdlet.Family"> <summary> <para> <para>You must specify a <code>family</code> for a task definition, which allows you to track multiple versions of the same task definition. The <code>family</code> is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RegisterECSTaskDefinitionCmdlet.Volume"> <summary> <para> <para>A list of volume definitions in JSON format that containers in your task may use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RegisterECSTaskDefinitionCmdlet.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.ECS.RemoveECSClusterCmdlet"> <summary> Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RemoveECSClusterCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RemoveECSClusterCmdlet.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.ECS.RemoveECSServiceCmdlet"> <summary> Deletes a specified service within a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RemoveECSServiceCmdlet.Cluster"> <summary> <para> <para>The name of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RemoveECSServiceCmdlet.Service"> <summary> <para> <para>The name of the service to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.RemoveECSServiceCmdlet.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.ECS.StartECSTaskCmdlet"> <summary> Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use <code>RunTask</code> instead. <important><para> The list of container instances to start tasks on is limited to 10. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StartECSTaskCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StartECSTaskCmdlet.ContainerInstance"> <summary> <para> <para>The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.</para><important><para>The list of container instances to start tasks on is limited to 10.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StartECSTaskCmdlet.Overrides_ContainerOverride"> <summary> <para> <para>One or more container overrides sent to a task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StartECSTaskCmdlet.StartedBy"> <summary> <para> <para>An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a>ListTasks</a> call with the <code>startedBy</code> value.</para><para>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StartECSTaskCmdlet.TaskDefinition"> <summary> <para> <para>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to start. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StartECSTaskCmdlet.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.ECS.StopECSTaskCmdlet"> <summary> Stops a running task. <para> When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StopECSTaskCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StopECSTaskCmdlet.Task"> <summary> <para> <para>The task ID or full Amazon Resource Name (ARN) entry of the task to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.StopECSTaskCmdlet.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.ECS.UnregisterECSContainerInstanceCmdlet"> <summary> Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. <para> If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources. </para><para> Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. </para><note><para> When you terminate a container instance, it is automatically deregistered from your cluster. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UnregisterECSContainerInstanceCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UnregisterECSContainerInstanceCmdlet.ContainerInstance"> <summary> <para> <para>The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UnregisterECSContainerInstanceCmdlet.ForceDeregistration"> <summary> <para> <para>Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> option, these tasks remain running and they continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UnregisterECSContainerInstanceCmdlet.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.ECS.UnregisterECSTaskDefinitionCmdlet"> <summary> Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count. <para> You cannot use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you cannot update an existing service to reference an <code>INACTIVE</code> task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UnregisterECSTaskDefinitionCmdlet.TaskDefinition"> <summary> <para> <para>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a <code>revision</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UnregisterECSTaskDefinitionCmdlet.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.ECS.UpdateECSContainerAgentCmdlet"> <summary> Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system. <para><code>UpdateContainerAgent</code> requires the Amazon ECS-optimized AMI or Amazon Linux with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually Updating the Amazon ECS Container Agent</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UpdateECSContainerAgentCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UpdateECSContainerAgentCmdlet.ContainerInstance"> <summary> <para> <para>The container instance ID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UpdateECSContainerAgentCmdlet.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.ECS.UpdateECSServiceCmdlet"> <summary> Modify the desired count or task definition used in a service. <para> You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter. </para><para> You can use <code>UpdateService</code> to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with <code>UpdateService</code>, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because <code>UpdateService</code> starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when <code>UpdateService</code> is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition. </para><para> When <a>UpdateService</a> replaces a task during an update, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UpdateECSServiceCmdlet.Cluster"> <summary> <para> <para>The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UpdateECSServiceCmdlet.DesiredCount"> <summary> <para> <para>The number of instantiations of the task to place and keep running in your service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UpdateECSServiceCmdlet.Service"> <summary> <para> <para>The name of the service to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UpdateECSServiceCmdlet.TaskDefinition"> <summary> <para> <para>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used. If you modify the task definition with <code>UpdateService</code>, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECS.UpdateECSServiceCmdlet.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.EC.AddECTagCmdlet"> <summary> The <i>AddTagsToResource</i> action adds up to 10 cost allocation tags to the named resource. A <i>cost allocation tag</i> is a key-value pair where the key and value are case-sensitive. Cost allocation tags can be used to categorize and track your AWS costs. <para> When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Tagging.html">Using Cost Allocation Tags in Amazon ElastiCache</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.AddECTagCmdlet.ResourceName"> <summary> <para> <para>The name of the resource to which the tags are to be added, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.AddECTagCmdlet.Tag"> <summary> <para> <para>A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.AddECTagCmdlet.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.EC.ApproveECCacheSecurityGroupIngressCmdlet"> <summary> The <i>AuthorizeCacheSecurityGroupIngress</i> action allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. <note>You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.ApproveECCacheSecurityGroupIngressCmdlet.CacheSecurityGroupName"> <summary> <para> <para>The cache security group which will allow network ingress.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.ApproveECCacheSecurityGroupIngressCmdlet.EC2SecurityGroupName"> <summary> <para> <para>The Amazon EC2 security group to be authorized for ingress to the cache security group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.ApproveECCacheSecurityGroupIngressCmdlet.EC2SecurityGroupOwnerId"> <summary> <para> <para>The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.ApproveECCacheSecurityGroupIngressCmdlet.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.EC.CopyECSnapshotCmdlet"> <summary> The <i>CopySnapshot</i> action makes a copy of an existing snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.CopyECSnapshotCmdlet.SourceSnapshotName"> <summary> <para> <para>The name of an existing snapshot from which to copy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.CopyECSnapshotCmdlet.TargetSnapshotName"> <summary> <para> <para>A name for the copied snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.CopyECSnapshotCmdlet.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.EC.EditECCacheClusterCmdlet"> <summary> The <i>ModifyCacheCluster</i> action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.ApplyImmediately"> <summary> <para> <para>If <code>true</code>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <i>PreferredMaintenanceWindow</i> setting for the cache cluster.</para><para>If <code>false</code>, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.</para><important>If you perform a <code>ModifyCacheCluster</code> before a pending modification is applied, the pending modification is replaced by the newer modification.</important><para>Valid values: <code>true</code> | <code>false</code></para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para>This parameter is currently disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.AZMode"> <summary> <para> <para>Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.</para><para>Valid values: <code>single-az</code> | <code>cross-az</code>.</para><para>This option is only supported for Memcached cache clusters.</para><note><para>You cannot specify <code>single-az</code> if the Memcached cache cluster already has cache nodes in different Availability Zones. If <code>cross-az</code> is specified, existing Memcached nodes remain in their current Availability Zone.</para><para>Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the <b>Availability Zone Considerations</b> section of <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html">Cache Node Considerations for Memcached</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.CacheClusterId"> <summary> <para> <para>The cache cluster identifier. This value is stored as a lowercase string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.CacheNodeIdsToRemove"> <summary> <para> <para>A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when <i>NumCacheNodes</i> is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of <i>NumCacheNodes</i> in the request.</para><para>For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this <code>ModifyCacheCluser</code> call is 5, you must list 2 (7 - 5) cache node IDs to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the <i>ApplyImmediately</i> parameter is specified as <i>true</i> for this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.CacheSecurityGroupName"> <summary> <para> <para>A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.</para><para>This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).</para><para>Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.EngineVersion"> <summary> <para> <para>The upgraded version of the cache engine to be run on the cache nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.NewAvailabilityZone"> <summary> <para> <para>The list of Availability Zones where the new Memcached cache nodes will be created.</para><para>This parameter is only valid when <i>NumCacheNodes</i> in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.</para><para>This option is only supported on Memcached clusters.</para><para>Scenarios: <ul><li><b>Scenario 1:</b> You have 3 active nodes and wish to add 2 nodes. Specify <code>NumCacheNodes=5</code> (3 + 2) and optionally specify two Availability Zones for the two new nodes.</li><li><b>Scenario 2:</b> You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify <code>NumCacheNodes=6</code> ((3 + 2) + 1)</li> and optionally specify an Availability Zone for the new node. <li><b>Scenario 3:</b> You want to cancel all pending actions. Specify <code>NumCacheNodes=3</code> to cancel all pending actions.</li></ul></para><para>The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting <code>NumCacheNodes</code> to the number of current nodes.</para><para>If <code>cross-az</code> is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the <b>Availability Zone Considerations</b> section of <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html">Cache Node Considerations for Memcached</a>.</para><para><b>Impact of new add/remove requests upon pending requests</b></para><table><tr><th>Scenarios</th><th>Pending action</th><th>New Request</th><th>Results</th></tr><tr><td>Scenario-1</td><td>Delete</td><td>Delete</td><td>The new delete, pending or immediate, replaces the pending delete.</td></tr><tr><td>Scenario-2</td><td>Delete</td><td>Create</td><td>The new create, pending or immediate, replaces the pending delete.</td></tr><tr><td>Scenario-3</td><td>Create</td><td>Delete</td><td>The new delete, pending or immediate, replaces the pending create.</td></tr><tr><td>Scenario-4</td><td>Create</td><td>Create</td><td>The new create is added to the pending create.<br /><b>Important:</b><br />If the new create request is <b>Apply Immediately - Yes</b>, all creates are performed immediately. If the new create request is <b>Apply Immediately - No</b>, all creates are pending.</td></tr></table><para>Example: <code>NewAvailabilityZones.member.1=us-west-2a&NewAvailabilityZones.member.2=us-west-2b&NewAvailabilityZones.member.3=us-west-2c</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.NotificationTopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.</para><note>The Amazon SNS topic owner must be same as the cache cluster owner. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.NotificationTopicStatus"> <summary> <para> <para>The status of the Amazon SNS notification topic. Notifications are sent only if the status is <i>active</i>.</para><para>Valid values: <code>active</code> | <code>inactive</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.NumCacheNode"> <summary> <para> <para>The number of cache nodes that the cache cluster should have. If the value for <code>NumCacheNodes</code> is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.</para><para>If you are removing cache nodes, you must use the <code>CacheNodeIdsToRemove</code> parameter to provide the IDs of the specific cache nodes to remove.</para><para>For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.</para><para><b>Note:</b>Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See <code>ApplyImmediately</code>. A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the <code>ModifyCacheCluster</code> request and set <i>NumCacheNodes</i> equal to the number of cache nodes currently in the cache cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for <code>ddd</code> are:</para><ul><li><code>sun</code></li><li><code>mon</code></li><li><code>tue</code></li><li><code>wed</code></li><li><code>thu</code></li><li><code>fri</code></li><li><code>sat</code></li></ul><para>Example: <code>sun:05:00-sun:09:00</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.SecurityGroupId"> <summary> <para> <para>Specifies the VPC Security Groups associated with the cache cluster.</para><para>This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.SnapshotRetentionLimit"> <summary> <para> <para>The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</para><para><b>Important</b>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.SnapshotWindow"> <summary> <para> <para>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheClusterCmdlet.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.EC.EditECCacheParameterGroupCmdlet"> <summary> The <i>ModifyCacheParameterGroup</i> action modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheParameterGroupCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of the cache parameter group to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheParameterGroupCmdlet.ParameterNameValue"> <summary> <para> <para>An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheParameterGroupCmdlet.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.EC.EditECCacheSubnetGroupCmdlet"> <summary> The <i>ModifyCacheSubnetGroup</i> action modifies an existing cache subnet group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheSubnetGroupCmdlet.CacheSubnetGroupDescription"> <summary> <para> <para>A description for the cache subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheSubnetGroupCmdlet.CacheSubnetGroupName"> <summary> <para> <para>The name for the cache subnet group. This value is stored as a lowercase string.</para><para>Constraints: Must contain no more than 255 alphanumeric characters or hyphens.</para><para>Example: <code>mysubnetgroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheSubnetGroupCmdlet.SubnetId"> <summary> <para> <para>The EC2 subnet IDs for the cache subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECCacheSubnetGroupCmdlet.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.EC.EditECReplicationGroupCmdlet"> <summary> The <i>ModifyReplicationGroup</i> action modifies the settings for a replication group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.ApplyImmediately"> <summary> <para> <para>If <code>true</code>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <i>PreferredMaintenanceWindow</i> setting for the replication group.</para><para>If <code>false</code>, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.</para><para>Valid values: <code>true</code> | <code>false</code></para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.AutomaticFailoverEnabled"> <summary> <para> <para>Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.</para><para>Valid values: <code>true</code> | <code>false</code></para><note><para>ElastiCache Multi-AZ replication groups are not supported on:</para><ul><li>Redis versions earlier than 2.8.6.</li><li>T1 and T2 cache node types.</li></ul></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para>This parameter is currently disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the <i>ApplyImmediately</i> parameter is specified as <i>true</i> for this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.CacheSecurityGroupName"> <summary> <para> <para>A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.</para><para>This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).</para><para>Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.EngineVersion"> <summary> <para> <para>The upgraded version of the cache engine to be run on the cache clusters in the replication group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.NotificationTopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.</para><note>The Amazon SNS topic owner must be same as the replication group owner. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.NotificationTopicStatus"> <summary> <para> <para>The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is <i>active</i>.</para><para>Valid values: <code>active</code> | <code>inactive</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for <code>ddd</code> are:</para><ul><li><code>sun</code></li><li><code>mon</code></li><li><code>tue</code></li><li><code>wed</code></li><li><code>thu</code></li><li><code>fri</code></li><li><code>sat</code></li></ul><para>Example: <code>sun:05:00-sun:09:00</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.PrimaryClusterId"> <summary> <para> <para>If this parameter is specified, ElastiCache will promote each of the cache clusters in the specified replication group to the primary role. The nodes of all other cache clusters in the replication group will be read replicas.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.ReplicationGroupDescription"> <summary> <para> <para>A description for the replication group. Maximum length is 255 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.ReplicationGroupId"> <summary> <para> <para>The identifier of the replication group to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.SecurityGroupId"> <summary> <para> <para>Specifies the VPC Security Groups associated with the cache clusters in the replication group.</para><para>This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.SnapshotRetentionLimit"> <summary> <para> <para>The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</para><para><b>Important</b>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.SnapshottingClusterId"> <summary> <para> <para>The cache cluster ID that will be used as the daily snapshot source for the replication group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.SnapshotWindow"> <summary> <para> <para>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by <i>SnapshottingClusterId</i>.</para><para>Example: <code>05:00-09:00</code></para><para>If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.EditECReplicationGroupCmdlet.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.EC.GetECCacheClusterCmdlet"> <summary> The <i>DescribeCacheClusters</i> action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied. <para> By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint. </para><para> If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned. </para><para> If the cluster is in the DELETING state, only cluster level information will be displayed. </para><para> If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is <i>available</i>, the cluster is ready for use. </para><para> If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheClusterCmdlet.CacheClusterId"> <summary> <para> <para>The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheClusterCmdlet.ShowCacheNodeInfo"> <summary> <para> <para>An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheClusterCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheClusterCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECCacheEngineVersionsCmdlet"> <summary> The <i>DescribeCacheEngineVersions</i> action returns a list of the available cache engines and their versions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheEngineVersionsCmdlet.CacheParameterGroupFamily"> <summary> <para> <para>The name of a specific cache parameter group family to return details for.</para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheEngineVersionsCmdlet.DefaultOnly"> <summary> <para> <para>If <i>true</i>, specifies that only the default version of the specified engine or engine and major version combination is to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheEngineVersionsCmdlet.Engine"> <summary> <para> <para>The cache engine to return. Valid values: <code>memcached</code> | <code>redis</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheEngineVersionsCmdlet.EngineVersion"> <summary> <para> <para>The cache engine version to return.</para><para>Example: <code>1.4.14</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheEngineVersionsCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheEngineVersionsCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterCmdlet"> <summary> The <i>DescribeCacheParameters</i> action returns the detailed parameter list for a particular cache parameter group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of a specific cache parameter group to return details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterCmdlet.Source"> <summary> <para> <para>The parameter types to return.</para><para>Valid values: <code>user</code> | <code>system</code> | <code>engine-default</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterGroupCmdlet"> <summary> The <i>DescribeCacheParameterGroups</i> action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterGroupCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of a specific cache parameter group to return details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterGroupCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheParameterGroupCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECCacheSecurityGroupCmdlet"> <summary> The <i>DescribeCacheSecurityGroups</i> action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheSecurityGroupCmdlet.CacheSecurityGroupName"> <summary> <para> <para>The name of the cache security group to return details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheSecurityGroupCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheSecurityGroupCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECCacheSubnetGroupsCmdlet"> <summary> The <i>DescribeCacheSubnetGroups</i> action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheSubnetGroupsCmdlet.CacheSubnetGroupName"> <summary> <para> <para>The name of the cache subnet group to return details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheSubnetGroupsCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECCacheSubnetGroupsCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECEngineDefaultParameterCmdlet"> <summary> The <i>DescribeEngineDefaultParameters</i> action returns the default engine and system parameter information for the specified cache engine. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEngineDefaultParameterCmdlet.CacheParameterGroupFamily"> <summary> <para> <para>The name of the cache parameter group family. Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEngineDefaultParameterCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEngineDefaultParameterCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECEventCmdlet"> <summary> The <i>DescribeEvents</i> action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter. <para> By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEventCmdlet.Duration"> <summary> <para> <para>The number of minutes' worth of events to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEventCmdlet.EndTime"> <summary> <para> <para>The end of the time interval for which to retrieve events, specified in ISO 8601 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEventCmdlet.SourceIdentifier"> <summary> <para> <para>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEventCmdlet.SourceType"> <summary> <para> <para>The event source to retrieve events for. If no value is specified, all events are returned.</para><para>Valid values are: <code>cache-cluster</code> | <code>cache-parameter-group</code> | <code>cache-security-group</code> | <code>cache-subnet-group</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEventCmdlet.StartTime"> <summary> <para> <para>The beginning of the time interval to retrieve events for, specified in ISO 8601 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEventCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECEventCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECReplicationGroupsCmdlet"> <summary> The <i>DescribeReplicationGroups</i> action returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReplicationGroupsCmdlet.ReplicationGroupId"> <summary> <para> <para>The identifier for the replication group to be described. This parameter is not case sensitive.</para><para>If you do not specify this parameter, information about all replication groups is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReplicationGroupsCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReplicationGroupsCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet"> <summary> The <i>DescribeReservedCacheNodes</i> action returns information about reserved cache nodes for this account, or about a specified reserved cache node. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet.CacheNodeType"> <summary> <para> <para>The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.</para><para>Valid node types are as follows:</para><ul><li>General purpose: <ul><li>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code></li><li>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code></li></ul></li><li>Compute optimized: <code>cache.c1.xlarge</code></li><li>Memory optimized <ul><li>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code></li><li>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code></li></ul></li></ul><para><b>Notes:</b></para><ul><li>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</li><li>Redis backup/restore is not supported for t2 instances.</li><li>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</li></ul><para>For a complete listing of cache node types and specifications, see <a href="http://aws.amazon.com/elasticache/details">Amazon ElastiCache Product Features and Details</a> and <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific">Cache Node Type-Specific Parameters for Memcached</a> or <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific">Cache Node Type-Specific Parameters for Redis</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet.Duration"> <summary> <para> <para>The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.</para><para>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet.OfferingType"> <summary> <para> <para>The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.</para><para>Valid values: <code>"Light Utilization"|"Medium Utilization"|"Heavy Utilization"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet.ProductDescription"> <summary> <para> <para>The product description filter value. Use this parameter to show only those reservations matching the specified product description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet.ReservedCacheNodeId"> <summary> <para> <para>The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet.ReservedCacheNodesOfferingId"> <summary> <para> <para>The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodeCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodesOfferingCmdlet"> <summary> The <i>DescribeReservedCacheNodesOfferings</i> action lists available reserved cache node offerings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodesOfferingCmdlet.CacheNodeType"> <summary> <para> <para>The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.</para><para>Valid node types are as follows:</para><ul><li>General purpose: <ul><li>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code></li><li>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code></li></ul></li><li>Compute optimized: <code>cache.c1.xlarge</code></li><li>Memory optimized <ul><li>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code></li><li>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code></li></ul></li></ul><para><b>Notes:</b></para><ul><li>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</li><li>Redis backup/restore is not supported for t2 instances.</li><li>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</li></ul><para>For a complete listing of cache node types and specifications, see <a href="http://aws.amazon.com/elasticache/details">Amazon ElastiCache Product Features and Details</a> and <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific">Cache Node Type-Specific Parameters for Memcached</a> or <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific">Cache Node Type-Specific Parameters for Redis</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodesOfferingCmdlet.Duration"> <summary> <para> <para>Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.</para><para>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodesOfferingCmdlet.OfferingType"> <summary> <para> <para>The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.</para><para>Valid Values: <code>"Light Utilization"|"Medium Utilization"|"Heavy Utilization"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodesOfferingCmdlet.ProductDescription"> <summary> <para> <para>The product description filter value. Use this parameter to show only the available offerings matching the specified product description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodesOfferingCmdlet.ReservedCacheNodesOfferingId"> <summary> <para> <para>The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.</para><para>Example: <code>438012d3-4052-4cc7-b2e3-8d3372e0e706</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodesOfferingCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECReservedCacheNodesOfferingCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 100</para><para>Constraints: minimum 20; maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECSnapshotsCmdlet"> <summary> The <i>DescribeSnapshots</i> action returns information about cache cluster snapshots. By default, <i>DescribeSnapshots</i> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECSnapshotsCmdlet.CacheClusterId"> <summary> <para> <para>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECSnapshotsCmdlet.SnapshotName"> <summary> <para> <para>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECSnapshotsCmdlet.SnapshotSource"> <summary> <para> <para>If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. If set to <code>user</code> the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECSnapshotsCmdlet.Marker"> <summary> <para> <para>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECSnapshotsCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</para><para>Default: 50</para><para>Constraints: minimum 20; maximum 50.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.GetECTagCmdlet"> <summary> The <i>ListTagsForResource</i> action lists all cost allocation tags currently on the named resource. A <i>cost allocation tag</i> is a key-value pair where the key is case-sensitive and the value is optional. Cost allocation tags can be used to categorize and track your AWS costs. <para> You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/BestPractices.html">Using Cost Allocation Tags in Amazon ElastiCache</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.GetECTagCmdlet.ResourceName"> <summary> <para> <para>The name of the resource for which you want the list of tags, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet"> <summary> The <i>CreateCacheCluster</i> action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para>This parameter is currently disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.AZMode"> <summary> <para> <para>Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.</para><para>This parameter is only supported for Memcached cache clusters.</para><para>If the <code>AZMode</code> and <code>PreferredAvailabilityZones</code> are not specified, ElastiCache assumes <code>single-az</code> mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.CacheClusterId"> <summary> <para> <para>The node group identifier. This parameter is stored as a lowercase string.</para><para>Constraints:</para><ul><li>A name must contain from 1 to 20 alphanumeric characters or hyphens.</li><li>The first character must be a letter.</li><li>A name cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.CacheNodeType"> <summary> <para> <para>The compute and memory capacity of the nodes in the node group.</para><para>Valid node types are as follows:</para><ul><li>General purpose: <ul><li>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code></li><li>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code></li></ul></li><li>Compute optimized: <code>cache.c1.xlarge</code></li><li>Memory optimized <ul><li>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code></li><li>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code></li></ul></li></ul><para><b>Notes:</b></para><ul><li>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</li><li>Redis backup/restore is not supported for t2 instances.</li><li>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</li></ul><para>For a complete listing of cache node types and specifications, see <a href="http://aws.amazon.com/elasticache/details">Amazon ElastiCache Product Features and Details</a> and <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific">Cache Node Type-Specific Parameters for Memcached</a> or <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific">Cache Node Type-Specific Parameters for Redis</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.CacheSecurityGroupName"> <summary> <para> <para>A list of security group names to associate with this cache cluster.</para><para>Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.CacheSubnetGroupName"> <summary> <para> <para>The name of the subnet group to be used for the cache cluster.</para><para>Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.Engine"> <summary> <para> <para>The name of the cache engine to be used for this cache cluster.</para><para>Valid values for this parameter are:</para><para><code>memcached</code> | <code>redis</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.EngineVersion"> <summary> <para> <para>The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the <i>DescribeCacheEngineVersions</i> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.NotificationTopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.</para><note>The Amazon SNS topic owner must be the same as the cache cluster owner.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.NumCacheNode"> <summary> <para> <para>The initial number of cache nodes that the cache cluster will have.</para><para>For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.</para><para>If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at <a href="http://aws.amazon.com/contact-us/elasticache-node-limit-request/">http://aws.amazon.com/contact-us/elasticache-node-limit-request/</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.Port"> <summary> <para> <para>The port number on which each of the cache nodes will accept connections.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.PreferredAvailabilityZone"> <summary> <para> <para>The EC2 Availability Zone in which the cache cluster will be created.</para><para>All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use <code>PreferredAvailabilityZones</code>.</para><para>Default: System chosen Availability Zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.PreferredAvailabilityZoneSet"> <summary> <para> <para>A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.</para><para>This option is only supported on Memcached.</para><note><para>If you are creating your cache cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.</para><para>The number of Availability Zones listed must equal the value of <code>NumCacheNodes</code>.</para></note><para>If you want all the nodes in the same Availability Zone, use <code>PreferredAvailabilityZone</code> instead, or repeat the Availability Zone multiple times in the list.</para><para>Default: System chosen Availability Zones.</para><para>Example: One Memcached node in each of three different Availability Zones: <code>PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c</code></para><para>Example: All three Memcached nodes in one Availability Zone: <code>PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for <code>ddd</code> are:</para><ul><li><code>sun</code></li><li><code>mon</code></li><li><code>tue</code></li><li><code>wed</code></li><li><code>thu</code></li><li><code>fri</code></li><li><code>sat</code></li></ul><para>Example: <code>sun:05:00-sun:09:00</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.ReplicationGroupId"> <summary> <para> <para>The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group.</para><para>If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.SecurityGroupId"> <summary> <para> <para>One or more VPC security groups associated with the cache cluster.</para><para>Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.SnapshotArn"> <summary> <para> <para>A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para><para>Example of an Amazon S3 ARN: <code>arn:aws:s3:::my_bucket/snapshot1.rdb</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.SnapshotName"> <summary> <para> <para>The name of a snapshot from which to restore data into the new node group. The snapshot status changes to <code>restoring</code> while the new node group is being created.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.SnapshotRetentionLimit"> <summary> <para> <para>The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para><para>Default: 0 (i.e., automatic backups are disabled for this cache cluster).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.SnapshotWindow"> <summary> <para> <para>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.</para><para>Example: <code>05:00-09:00</code></para><para>If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.Tag"> <summary> <para> <para>A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheClusterCmdlet.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.EC.NewECCacheParameterGroupCmdlet"> <summary> The <i>CreateCacheParameterGroup</i> action creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheParameterGroupCmdlet.CacheParameterGroupFamily"> <summary> <para> <para>The name of the cache parameter group family the cache parameter group can be used with.</para><para>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheParameterGroupCmdlet.CacheParameterGroupName"> <summary> <para> <para>A user-specified name for the cache parameter group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheParameterGroupCmdlet.Description"> <summary> <para> <para>A user-specified description for the cache parameter group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheParameterGroupCmdlet.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.EC.NewECCacheSecurityGroupCmdlet"> <summary> The <i>CreateCacheSecurityGroup</i> action creates a new cache security group. Use a cache security group to control access to one or more cache clusters. <para> Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html">CreateCacheSubnetGroup</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheSecurityGroupCmdlet.CacheSecurityGroupName"> <summary> <para> <para>A name for the cache security group. This value is stored as a lowercase string.</para><para>Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".</para><para>Example: <code>mysecuritygroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheSecurityGroupCmdlet.Description"> <summary> <para> <para>A description for the cache security group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheSecurityGroupCmdlet.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.EC.NewECCacheSubnetGroupCmdlet"> <summary> The <i>CreateCacheSubnetGroup</i> action creates a new cache subnet group. <para> Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheSubnetGroupCmdlet.CacheSubnetGroupDescription"> <summary> <para> <para>A description for the cache subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheSubnetGroupCmdlet.CacheSubnetGroupName"> <summary> <para> <para>A name for the cache subnet group. This value is stored as a lowercase string.</para><para>Constraints: Must contain no more than 255 alphanumeric characters or hyphens.</para><para>Example: <code>mysubnetgroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheSubnetGroupCmdlet.SubnetId"> <summary> <para> <para>A list of VPC subnet IDs for the cache subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECCacheSubnetGroupCmdlet.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.EC.NewECReplicationGroupCmdlet"> <summary> The <i>CreateReplicationGroup</i> action creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas. <para> When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas. </para><para><b>Note:</b> This action is valid only for Redis. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.AutomaticFailoverEnabled"> <summary> <para> <para>Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.</para><para>If <code>true</code>, Multi-AZ is enabled for this replication group. If <code>false</code>, Multi-AZ is disabled for this replication group.</para><para>Default: false</para><note><para>ElastiCache Multi-AZ replication groups is not supported on:</para><ul><li>Redis versions earlier than 2.8.6.</li><li>T1 and T2 cache node types.</li></ul></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para>This parameter is currently disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.CacheNodeType"> <summary> <para> <para>The compute and memory capacity of the nodes in the node group.</para><para>Valid node types are as follows:</para><ul><li>General purpose: <ul><li>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code></li><li>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code></li></ul></li><li>Compute optimized: <code>cache.c1.xlarge</code></li><li>Memory optimized <ul><li>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code></li><li>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code></li></ul></li></ul><para><b>Notes:</b></para><ul><li>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</li><li>Redis backup/restore is not supported for t2 instances.</li><li>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</li></ul><para>For a complete listing of cache node types and specifications, see <a href="http://aws.amazon.com/elasticache/details">Amazon ElastiCache Product Features and Details</a> and <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific">Cache Node Type-Specific Parameters for Memcached</a> or <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific">Cache Node Type-Specific Parameters for Redis</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.CacheSecurityGroupName"> <summary> <para> <para>A list of cache security group names to associate with this replication group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.CacheSubnetGroupName"> <summary> <para> <para>The name of the cache subnet group to be used for the replication group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.Engine"> <summary> <para> <para>The name of the cache engine to be used for the cache clusters in this replication group.</para><para>Default: redis</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.EngineVersion"> <summary> <para> <para>The version number of the cache engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the <i>DescribeCacheEngineVersions</i> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.NotificationTopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.</para><note>The Amazon SNS topic owner must be the same as the cache cluster owner.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.NumCacheCluster"> <summary> <para> <para>The number of cache clusters this replication group will initially have.</para><para>If <i>Multi-AZ</i> is <code>enabled</code>, the value of this parameter must be at least 2.</para><para>The maximum permitted value for <i>NumCacheClusters</i> is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at <a href="http://aws.amazon.com/contact-us/elasticache-node-limit-request">http://aws.amazon.com/contact-us/elasticache-node-limit-request</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.Port"> <summary> <para> <para>The port number on which each member of the replication group will accept connections.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.PreferredCacheClusterAZs"> <summary> <para> <para>A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important.</para><note>If you are creating your replication group in an Amazon VPC (recommended), you can only locate cache clusters in availability zones associated with the subnets in the selected subnet group. <para>The number of availability zones listed must equal the value of <i>NumCacheClusters</i>.</para></note><para>Default: system chosen availability zones.</para><para>Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for <code>ddd</code> are:</para><ul><li><code>sun</code></li><li><code>mon</code></li><li><code>tue</code></li><li><code>wed</code></li><li><code>thu</code></li><li><code>fri</code></li><li><code>sat</code></li></ul><para>Example: <code>sun:05:00-sun:09:00</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.PrimaryClusterId"> <summary> <para> <para>The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of <i>available</i>.</para><para>This parameter is not required if <i>NumCacheClusters</i> is specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.ReplicationGroupDescription"> <summary> <para> <para>A user-created description for the replication group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.ReplicationGroupId"> <summary> <para> <para>The replication group identifier. This parameter is stored as a lowercase string.</para><para>Constraints:</para><ul><li>A name must contain from 1 to 20 alphanumeric characters or hyphens.</li><li>The first character must be a letter.</li><li>A name cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.SecurityGroupId"> <summary> <para> <para>One or more Amazon VPC security groups associated with this replication group.</para><para>Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.SnapshotArn"> <summary> <para> <para>A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para><para>Example of an Amazon S3 ARN: <code>arn:aws:s3:::my_bucket/snapshot1.rdb</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.SnapshotName"> <summary> <para> <para>The name of a snapshot from which to restore data into the new node group. The snapshot status changes to <code>restoring</code> while the new node group is being created.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.SnapshotRetentionLimit"> <summary> <para> <para>The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para><para>Default: 0 (i.e., automatic backups are disabled for this cache cluster).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.SnapshotWindow"> <summary> <para> <para>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.</para><para>Example: <code>05:00-09:00</code></para><para>If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.</para><para><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.Tag"> <summary> <para> <para>A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECReplicationGroupCmdlet.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.EC.NewECSnapshotCmdlet"> <summary> The <i>CreateSnapshot</i> action creates a copy of an entire cache cluster at a specific moment in time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECSnapshotCmdlet.CacheClusterId"> <summary> <para> <para>The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECSnapshotCmdlet.SnapshotName"> <summary> <para> <para>A name for the snapshot being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.NewECSnapshotCmdlet.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.EC.RemoveECCacheClusterCmdlet"> <summary> The <i>DeleteCacheCluster</i> action deletes a previously provisioned cache cluster. <i>DeleteCacheCluster</i> deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action. <para> This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheClusterCmdlet.CacheClusterId"> <summary> <para> <para>The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheClusterCmdlet.FinalSnapshotIdentifier"> <summary> <para> <para>The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheClusterCmdlet.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.EC.RemoveECCacheParameterGroupCmdlet"> <summary> The <i>DeleteCacheParameterGroup</i> action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheParameterGroupCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of the cache parameter group to delete.</para><note>The specified cache security group must not be associated with any cache clusters.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheParameterGroupCmdlet.PassThru"> <summary> Returns the value passed to the CacheParameterGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheParameterGroupCmdlet.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.EC.RemoveECCacheSecurityGroupCmdlet"> <summary> The <i>DeleteCacheSecurityGroup</i> action deletes a cache security group. <note>You cannot delete a cache security group if it is associated with any cache clusters.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheSecurityGroupCmdlet.CacheSecurityGroupName"> <summary> <para> <para>The name of the cache security group to delete.</para><note>You cannot delete the default security group.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheSecurityGroupCmdlet.PassThru"> <summary> Returns the value passed to the CacheSecurityGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheSecurityGroupCmdlet.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.EC.RemoveECCacheSubnetGroupCmdlet"> <summary> The <i>DeleteCacheSubnetGroup</i> action deletes a cache subnet group. <note>You cannot delete a cache subnet group if it is associated with any cache clusters.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheSubnetGroupCmdlet.CacheSubnetGroupName"> <summary> <para> <para>The name of the cache subnet group to delete.</para><para>Constraints: Must contain no more than 255 alphanumeric characters or hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheSubnetGroupCmdlet.PassThru"> <summary> Returns the value passed to the CacheSubnetGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECCacheSubnetGroupCmdlet.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.EC.RemoveECReplicationGroupCmdlet"> <summary> The <i>DeleteReplicationGroup</i> action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster. <para> When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECReplicationGroupCmdlet.FinalSnapshotIdentifier"> <summary> <para> <para>The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECReplicationGroupCmdlet.ReplicationGroupId"> <summary> <para> <para>The identifier for the cluster to be deleted. This parameter is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECReplicationGroupCmdlet.RetainPrimaryCluster"> <summary> <para> <para>If set to <i>true</i>, all of the read replicas will be deleted, but the primary node will be retained.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECReplicationGroupCmdlet.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.EC.RemoveECSnapshotCmdlet"> <summary> The <i>DeleteSnapshot</i> action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECSnapshotCmdlet.SnapshotName"> <summary> <para> <para>The name of the snapshot to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECSnapshotCmdlet.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.EC.RemoveECTagCmdlet"> <summary> The <i>RemoveTagsFromResource</i> action removes the tags identified by the <code>TagKeys</code> list from the named resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECTagCmdlet.ResourceName"> <summary> <para> <para>The name of the ElastiCache resource from which you want the listed tags removed, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECTagCmdlet.TagKey"> <summary> <para> <para>A list of <code>TagKeys</code> identifying the tags you want removed from the named resource. For example, <code>TagKeys.member.1=Region</code> removes the cost allocation tag with the key name <code>Region</code> from the resource named by the <i>ResourceName</i> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RemoveECTagCmdlet.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.EC.RequestECReservedCacheNodesOfferingCmdlet"> <summary> The <i>PurchaseReservedCacheNodesOffering</i> action allows you to purchase a reserved cache node offering. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RequestECReservedCacheNodesOfferingCmdlet.CacheNodeCount"> <summary> <para> <para>The number of cache node instances to reserve.</para><para>Default: <code>1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RequestECReservedCacheNodesOfferingCmdlet.ReservedCacheNodeId"> <summary> <para> <para>A customer-specified identifier to track this reservation.</para><para>Example: myreservationID</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RequestECReservedCacheNodesOfferingCmdlet.ReservedCacheNodesOfferingId"> <summary> <para> <para>The ID of the reserved cache node offering to purchase.</para><para>Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RequestECReservedCacheNodesOfferingCmdlet.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.EC.ResetECCacheParameterGroupCmdlet"> <summary> The <i>ResetCacheParameterGroup</i> action modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the <i>ResetAllParameters</i> and <i>CacheParameterGroupName</i> parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.ResetECCacheParameterGroupCmdlet.CacheParameterGroupName"> <summary> <para> <para>The name of the cache parameter group to reset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.ResetECCacheParameterGroupCmdlet.ParameterNameValue"> <summary> <para> <para>An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.ResetECCacheParameterGroupCmdlet.ResetAllParameter"> <summary> <para> <para>If <i>true</i>, all parameters in the cache parameter group will be reset to default values. If <i>false</i>, no such action occurs.</para><para>Valid values: <code>true</code> | <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.ResetECCacheParameterGroupCmdlet.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.EC.RestartECCacheClusterCmdlet"> <summary> The <i>RebootCacheCluster</i> action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING. <para> The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. </para><para> When the reboot is complete, a cache cluster event is created. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RestartECCacheClusterCmdlet.CacheClusterId"> <summary> <para> <para>The cache cluster identifier. This parameter is stored as a lowercase string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RestartECCacheClusterCmdlet.CacheNodeIdsToReboot"> <summary> <para> <para>A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RestartECCacheClusterCmdlet.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.EC.RevokeECCacheSecurityGroupIngressCmdlet"> <summary> The <i>RevokeCacheSecurityGroupIngress</i> action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RevokeECCacheSecurityGroupIngressCmdlet.CacheSecurityGroupName"> <summary> <para> <para>The name of the cache security group to revoke ingress from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RevokeECCacheSecurityGroupIngressCmdlet.EC2SecurityGroupName"> <summary> <para> <para>The name of the Amazon EC2 security group to revoke access from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RevokeECCacheSecurityGroupIngressCmdlet.EC2SecurityGroupOwnerId"> <summary> <para> <para>The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EC.RevokeECCacheSecurityGroupIngressCmdlet.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.EB.GetEBApplicationCmdlet"> <summary> Returns the descriptions of existing applications. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBApplicationCmdlet.ApplicationName"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBApplicationVersionCmdlet"> <summary> Returns descriptions for existing application versions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBApplicationVersionCmdlet.ApplicationName"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBApplicationVersionCmdlet.VersionLabel"> <summary> <para> <para> If specified, restricts the returned descriptions to only include ones that have the specified version labels. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBAvailableSolutionStackCmdlet"> <summary> Returns a list of the available solution stack names. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationOptionCmdlet"> <summary> Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationOptionCmdlet.ApplicationName"> <summary> <para> <para> The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationOptionCmdlet.EnvironmentName"> <summary> <para> <para> The name of the environment whose configuration options you want to describe. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationOptionCmdlet.Option"> <summary> <para> <para> If specified, restricts the descriptions to only the specified options. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationOptionCmdlet.TemplateName"> <summary> <para> <para> The name of the configuration template whose configuration options you want to describe. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationOptionCmdlet.SolutionStackName"> <summary> <para> <para> The name of the solution stack whose configuration options you want to describe. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationSettingCmdlet"> <summary> Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment. <para> When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy. </para><para> Related Topics </para><ul><li><a>DeleteEnvironmentConfiguration</a></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationSettingCmdlet.ApplicationName"> <summary> <para> <para> The application for the environment or configuration template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationSettingCmdlet.EnvironmentName"> <summary> <para> <para> The name of the environment to describe. </para><para> Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBConfigurationSettingCmdlet.TemplateName"> <summary> <para> <para> The name of the configuration template to describe. </para><para> Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBDNSAvailabilityCmdlet"> <summary> Checks if the specified CNAME is available. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBDNSAvailabilityCmdlet.CNAMEPrefix"> <summary> <para> <para> The prefix used when this CNAME is reserved. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentCmdlet"> <summary> Returns descriptions for existing environments. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentCmdlet.ApplicationName"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentCmdlet.EnvironmentName"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentCmdlet.IncludedDeletedBackTo"> <summary> <para> <para> If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then environments deleted after this date are displayed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentCmdlet.IncludeDeleted"> <summary> <para> <para>Indicates whether to include deleted environments: </para><para><code>true</code>: Environments that have been deleted after <code>IncludedDeletedBackTo</code> are displayed. </para><para><code>false</code>: Do not include deleted environments. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentCmdlet.VersionLabel"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentHealthCmdlet"> <summary> Returns information about the overall health of the specified environment. The <b>DescribeEnvironmentHealth</b> operation is only available with AWS Elastic Beanstalk Enhanced Health. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentHealthCmdlet.AttributeName"> <summary> <para> <para>Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk returns all response elements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentHealthCmdlet.EnvironmentId"> <summary> <para> <para>Specifies the AWS Elastic Beanstalk environment ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentHealthCmdlet.EnvironmentName"> <summary> <para> <para>Specifies the AWS Elastic Beanstalk environment name.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentInfoCmdlet"> <summary> Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request. <para> Related Topics </para><ul><li><a>RequestEnvironmentInfo</a></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentInfoCmdlet.EnvironmentId"> <summary> <para> <para>The ID of the data's environment.</para><para> If no such environment is found, returns an <code>InvalidParameterValue</code> error. </para><para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentInfoCmdlet.EnvironmentName"> <summary> <para> <para>The name of the data's environment.</para><para> If no such environment is found, returns an <code>InvalidParameterValue</code> error. </para><para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentInfoCmdlet.InfoType"> <summary> <para> <para> The type of information to retrieve. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentResourceCmdlet"> <summary> Returns AWS resources for this environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentResourceCmdlet.EnvironmentId"> <summary> <para> <para> The ID of the environment to retrieve AWS resource usage data. </para><para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEnvironmentResourceCmdlet.EnvironmentName"> <summary> <para> <para> The name of the environment to retrieve AWS resource usage data. </para><para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet"> <summary> Returns list of event descriptions matching criteria up to the last 6 weeks. <note> This action returns the most recent 1,000 events from the specified <code>NextToken</code>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.ApplicationName"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.EndTime"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the <code>EndTime</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.EnvironmentId"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.EnvironmentName"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.RequestId"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.Severity"> <summary> <para> <para> If specified, limits the events returned from this call to include only those with the specified severity or higher. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.StartTime"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.TemplateName"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.VersionLabel"> <summary> <para> <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.MaxRecord"> <summary> <para> <para> Specifies the maximum number of events that can be returned, beginning with the most recent event. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBEventCmdlet.NextToken"> <summary> <para> <para> Pagination token. If specified, the events return the next batch of results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.GetEBInstanceHealthCmdlet"> <summary> Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The <b>DescribeInstancesHealth</b> operation is only available with AWS Elastic Beanstalk Enhanced Health. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBInstanceHealthCmdlet.AttributeName"> <summary> <para> <para>Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk returns all response elements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBInstanceHealthCmdlet.EnvironmentId"> <summary> <para> <para>Specifies the AWS Elastic Beanstalk environment ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBInstanceHealthCmdlet.EnvironmentName"> <summary> <para> <para>Specifies the AWS Elastic Beanstalk environment name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.GetEBInstanceHealthCmdlet.NextToken"> <summary> <para> <para>Specifies the next token of the request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationCmdlet"> <summary> Creates an application that has one configuration template named <code>default</code> and no application versions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationCmdlet.ApplicationName"> <summary> <para> <para>The name of the application.</para><para> Constraint: This name must be unique within your account. If the specified name already exists, the action returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationCmdlet.Description"> <summary> <para> <para>Describes the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationCmdlet.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.EB.NewEBApplicationVersionCmdlet"> <summary> Creates an application version for the specified application. <note>Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationVersionCmdlet.ApplicationName"> <summary> <para> <para> The name of the application. If no application is found with this name, and <code>AutoCreateApplication</code> is <code>false</code>, returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationVersionCmdlet.AutoCreateApplication"> <summary> <para> <para> Determines how the system behaves if the specified application for this version does not already exist: </para><enumValues><value name="true"><para><code>true</code>: Automatically creates the specified application for this version if it does not already exist. </para></value><value name="false"><para><code>false</code>: Returns an <code>InvalidParameterValue</code> if the specified application for this version does not already exist. </para></value></enumValues><ul><li><code>true</code> : Automatically creates the specified application for this release if it does not already exist. </li><li><code>false</code> : Throws an <code>InvalidParameterValue</code> if the specified application for this release does not already exist. </li></ul><para> Default: <code>false</code></para><para> Valid Values: <code>true</code> | <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationVersionCmdlet.Description"> <summary> <para> <para>Describes this version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationVersionCmdlet.SourceBundle_S3Bucket"> <summary> <para> <para>The Amazon S3 bucket where the data is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationVersionCmdlet.SourceBundle_S3Key"> <summary> <para> <para>The Amazon S3 key where the data is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationVersionCmdlet.VersionLabel"> <summary> <para> <para>A label identifying this version.</para><para>Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBApplicationVersionCmdlet.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.EB.NewEBConfigurationTemplateCmdlet"> <summary> Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings. <para> Related Topics </para><ul><li><a>DescribeConfigurationOptions</a></li><li><a>DescribeConfigurationSettings</a></li><li><a>ListAvailableSolutionStacks</a></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.ApplicationName"> <summary> <para> <para> The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.SourceConfiguration_ApplicationName"> <summary> <para> <para>The name of the application associated with the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.Description"> <summary> <para> <para>Describes this configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.EnvironmentId"> <summary> <para> <para> The ID of the environment used with this configuration template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.OptionSetting"> <summary> <para> <para> If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.SourceConfiguration_TemplateName"> <summary> <para> <para>The name of the configuration template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.TemplateName"> <summary> <para> <para>The name of the configuration template.</para><para>Constraint: This name must be unique per application. </para><para>Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.SolutionStackName"> <summary> <para> <para>The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values. </para><para> Use <a>ListAvailableSolutionStacks</a> to obtain a list of available solution stacks. </para><para> A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para><para> If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBConfigurationTemplateCmdlet.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.EB.NewEBEnvironmentCmdlet"> <summary> Launches an environment for the specified application using the specified configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.ApplicationName"> <summary> <para> <para> The name of the application that contains the version to be deployed. </para><para> If no application is found with this name, <code>CreateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.CNAMEPrefix"> <summary> <para> <para> If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.Description"> <summary> <para> <para>Describes this environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.EnvironmentName"> <summary> <para> <para> A unique name for the deployment environment. Used in the application URL. </para><para>Constraint: Must be from 4 to 23 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para><para>Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.Tier_Name"> <summary> <para> <para>The name of this environment tier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.OptionSetting"> <summary> <para> <para> If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.OptionsToRemove"> <summary> <para> <para> A list of custom user-defined configuration options to remove from the configuration set for this new environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.Tag"> <summary> <para> <para> This specifies the tags applied to resources in the environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.TemplateName"> <summary> <para> <para> The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para><para> Condition: You must specify either this parameter or a <code>SolutionStackName</code>, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.Tier_Type"> <summary> <para> <para>The type of this environment tier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.Tier_Version"> <summary> <para> <para>The version of this environment tier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.VersionLabel"> <summary> <para> <para>The name of the application version to deploy.</para><para> If the specified application has no associated application versions, AWS Elastic Beanstalk <code>UpdateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </para><para> Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.SolutionStackName"> <summary> <para> <para> This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. </para><para> Condition: You must specify either this or a <code>TemplateName</code>, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBEnvironmentCmdlet.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.EB.NewEBStorageLocationCmdlet"> <summary> Creates the Amazon S3 storage location for the account. <para> This location is used to store user log files. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.NewEBStorageLocationCmdlet.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.EB.RemoveEBApplicationCmdlet"> <summary> Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. <note>You cannot delete an application that has a running environment. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationCmdlet.ApplicationName"> <summary> <para> <para>The name of the application to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationCmdlet.TerminateEnvByForce"> <summary> <para> <para>When set to true, running environments will be terminated before deleting the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationCmdlet.PassThru"> <summary> Returns the value passed to the ApplicationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationCmdlet.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.EB.RemoveEBApplicationVersionCmdlet"> <summary> Deletes the specified version from the specified application. <note>You cannot delete an application version that is associated with a running environment.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationVersionCmdlet.ApplicationName"> <summary> <para> <para>The name of the application to delete releases from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationVersionCmdlet.DeleteSourceBundle"> <summary> <para> <para>Indicates whether to delete the associated source bundle from Amazon S3: </para><ul><li><code>true</code>: An attempt is made to delete the associated Amazon S3 source bundle specified at time of creation. </li><li><code>false</code>: No action is taken on the Amazon S3 source bundle specified at time of creation. </li></ul><para> Valid Values: <code>true</code> | <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationVersionCmdlet.VersionLabel"> <summary> <para> <para> The label of the version to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationVersionCmdlet.PassThru"> <summary> Returns the value passed to the ApplicationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBApplicationVersionCmdlet.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.EB.RemoveEBConfigurationTemplateCmdlet"> <summary> Deletes the specified configuration template. <note>When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBConfigurationTemplateCmdlet.ApplicationName"> <summary> <para> <para> The name of the application to delete the configuration template from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBConfigurationTemplateCmdlet.TemplateName"> <summary> <para> <para>The name of the configuration template to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBConfigurationTemplateCmdlet.PassThru"> <summary> Returns the value passed to the ApplicationName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBConfigurationTemplateCmdlet.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.EB.RemoveEBEnvironmentConfigurationCmdlet"> <summary> Deletes the draft configuration associated with the running environment. <para> Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using <a>DescribeConfigurationSettings</a> while the update is in progress or if the update fails. The <code>DeploymentStatus</code> for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBEnvironmentConfigurationCmdlet.ApplicationName"> <summary> <para> <para> The name of the application the environment is associated with. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBEnvironmentConfigurationCmdlet.EnvironmentName"> <summary> <para> <para> The name of the environment to delete the draft configuration from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBEnvironmentConfigurationCmdlet.PassThru"> <summary> Returns the name of the environment that was updated. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RemoveEBEnvironmentConfigurationCmdlet.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.EB.RequestEBEnvironmentInfoCmdlet"> <summary> Initiates a request to compile the specified type of information of the deployed environment. <para> Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. </para><para> Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs. </para><para> Use <a>RetrieveEnvironmentInfo</a> to obtain the set of logs. </para><para> Related Topics </para><ul><li><a>RetrieveEnvironmentInfo</a></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RequestEBEnvironmentInfoCmdlet.EnvironmentId"> <summary> <para> <para>The ID of the environment of the requested data.</para><para> If no such environment is found, <code>RequestEnvironmentInfo</code> returns an <code>InvalidParameterValue</code> error. </para><para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RequestEBEnvironmentInfoCmdlet.EnvironmentName"> <summary> <para> <para>The name of the environment of the requested data.</para><para> If no such environment is found, <code>RequestEnvironmentInfo</code> returns an <code>InvalidParameterValue</code> error. </para><para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RequestEBEnvironmentInfoCmdlet.InfoType"> <summary> <para> <para> The type of information to request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RequestEBEnvironmentInfoCmdlet.PassThru"> <summary> Returns the id or name of the environment (depending on which parameter was supplied). By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RequestEBEnvironmentInfoCmdlet.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.EB.RestartEBAppServerCmdlet"> <summary> Causes the environment to restart the application container server running on each Amazon EC2 instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RestartEBAppServerCmdlet.EnvironmentId"> <summary> <para> <para> The ID of the environment to restart the server for. </para><para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RestartEBAppServerCmdlet.EnvironmentName"> <summary> <para> <para> The name of the environment to restart the server for. </para><para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RestartEBAppServerCmdlet.PassThru"> <summary> Returns the id or name of the environment (depending on which parameter was supplied). By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.RestartEBAppServerCmdlet.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.EB.SetEBEnvironmentCNAMECmdlet"> <summary> Swaps the CNAMEs of two environments. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.SetEBEnvironmentCNAMECmdlet.DestinationEnvironmentId"> <summary> <para> <para> The ID of the destination environment. </para><para> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the <code>SourceEnvironmentId</code> with the <code>DestinationEnvironmentId</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.SetEBEnvironmentCNAMECmdlet.DestinationEnvironmentName"> <summary> <para> <para> The name of the destination environment. </para><para> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the <code>SourceEnvironmentName</code> with the <code>DestinationEnvironmentName</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.SetEBEnvironmentCNAMECmdlet.SourceEnvironmentId"> <summary> <para> <para> The ID of the source environment. </para><para> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the <code>SourceEnvironmentName</code>. You may also specify both. If you specify the <code>SourceEnvironmentId</code>, you must specify the <code>DestinationEnvironmentId</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.SetEBEnvironmentCNAMECmdlet.SourceEnvironmentName"> <summary> <para> <para> The name of the source environment. </para><para> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the <code>SourceEnvironmentName</code>. You may also specify both. If you specify the <code>SourceEnvironmentName</code>, you must specify the <code>DestinationEnvironmentName</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.SetEBEnvironmentCNAMECmdlet.PassThru"> <summary> Returns the value passed to the SourceEnvironmentId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.SetEBEnvironmentCNAMECmdlet.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.EB.StartEBEnvironmentRebuildCmdlet"> <summary> Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StartEBEnvironmentRebuildCmdlet.EnvironmentId"> <summary> <para> <para> The ID of the environment to rebuild. </para><para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StartEBEnvironmentRebuildCmdlet.EnvironmentName"> <summary> <para> <para> The name of the environment to rebuild. </para><para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StartEBEnvironmentRebuildCmdlet.PassThru"> <summary> Returns the id or name of the environment (depending on which parameter was supplied). By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StartEBEnvironmentRebuildCmdlet.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.EB.StopEBEnvironmentCmdlet"> <summary> Terminates the specified environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StopEBEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>The ID of the environment to terminate.</para><para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StopEBEnvironmentCmdlet.EnvironmentName"> <summary> <para> <para>The name of the environment to terminate.</para><para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StopEBEnvironmentCmdlet.TerminateResource"> <summary> <para> <para> Indicates whether the associated AWS resources should shut down when the environment is terminated: </para><enumValues><value name="true"><para><code>true</code>: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </para></value><value name="false"><para><code>false</code>: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </para></value></enumValues><ul><li><code>true</code>: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. </li><li><code>false</code>: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. </li></ul><para> For more information, see the <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/ug/"> AWS Elastic Beanstalk User Guide. </a></para><para> Default: <code>true</code></para><para> Valid Values: <code>true</code> | <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StopEBEnvironmentCmdlet.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.EB.StopEBEnvironmentUpdateCmdlet"> <summary> Cancels in-progress environment configuration update or application version deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StopEBEnvironmentUpdateCmdlet.EnvironmentId"> <summary> <para> <para>This specifies the ID of the environment with the in-progress update that you want to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StopEBEnvironmentUpdateCmdlet.EnvironmentName"> <summary> <para> <para>This specifies the name of the environment with the in-progress update that you want to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.StopEBEnvironmentUpdateCmdlet.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.EB.TestEBConfigurationSettingCmdlet"> <summary> Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. <para> This action returns a list of messages indicating any errors or warnings associated with the selection of option values. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.TestEBConfigurationSettingCmdlet.ApplicationName"> <summary> <para> <para> The name of the application that the configuration template or environment belongs to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.TestEBConfigurationSettingCmdlet.EnvironmentName"> <summary> <para> <para> The name of the environment to validate the settings against. </para><para> Condition: You cannot specify both this and a configuration template name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.TestEBConfigurationSettingCmdlet.OptionSetting"> <summary> <para> <para> A list of the options and desired values to evaluate. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.TestEBConfigurationSettingCmdlet.TemplateName"> <summary> <para> <para> The name of the configuration template to validate the settings against. </para><para> Condition: You cannot specify both this and an environment name. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EB.UpdateEBApplicationCmdlet"> <summary> Updates the specified application to have the specified properties. <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear these properties, specify an empty string. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBApplicationCmdlet.ApplicationName"> <summary> <para> <para> The name of the application to update. If no such application is found, <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBApplicationCmdlet.Description"> <summary> <para> <para> A new description for the application. </para><para>Default: If not specified, AWS Elastic Beanstalk does not update the description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBApplicationCmdlet.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.EB.UpdateEBApplicationVersionCmdlet"> <summary> Updates the specified application version to have the specified properties. <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty string. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBApplicationVersionCmdlet.ApplicationName"> <summary> <para> <para> The name of the application associated with this version. </para><para> If no application is found with this name, <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBApplicationVersionCmdlet.Description"> <summary> <para> <para>A new description for this release.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBApplicationVersionCmdlet.VersionLabel"> <summary> <para> <para>The name of the version to update.</para><para> If no application version is found with this label, <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBApplicationVersionCmdlet.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.EB.UpdateEBConfigurationTemplateCmdlet"> <summary> Updates the specified configuration template to have the specified properties or configuration option values. <note> If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty string. </note><para> Related Topics </para><ul><li><a>DescribeConfigurationOptions</a></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBConfigurationTemplateCmdlet.ApplicationName"> <summary> <para> <para>The name of the application associated with the configuration template to update.</para><para> If no application is found with this name, <code>UpdateConfigurationTemplate</code> returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBConfigurationTemplateCmdlet.Description"> <summary> <para> <para>A new description for the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBConfigurationTemplateCmdlet.OptionSetting"> <summary> <para> <para> A list of configuration option settings to update with the new specified option value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBConfigurationTemplateCmdlet.OptionsToRemove"> <summary> <para> <para> A list of configuration options to remove from the configuration set. </para><para> Constraint: You can remove only <code>UserDefined</code> configuration options. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBConfigurationTemplateCmdlet.TemplateName"> <summary> <para> <para>The name of the configuration template to update.</para><para> If no configuration template is found with this name, <code>UpdateConfigurationTemplate</code> returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBConfigurationTemplateCmdlet.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.EB.UpdateEBEnvironmentCmdlet"> <summary> Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment. <para> Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </para><para> When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.Description"> <summary> <para> <para> If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>The ID of the environment to update.</para><para> If no environment with this ID exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para><para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.EnvironmentName"> <summary> <para> <para>The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para><para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.Tier_Name"> <summary> <para> <para>The name of this environment tier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.OptionSetting"> <summary> <para> <para> If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.OptionsToRemove"> <summary> <para> <para> A list of custom user-defined configuration options to remove from the configuration set for this environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.TemplateName"> <summary> <para> <para> If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.Tier_Type"> <summary> <para> <para>The type of this environment tier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.Tier_Version"> <summary> <para> <para>The version of this environment tier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.VersionLabel"> <summary> <para> <para> If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an <code>InvalidParameterValue</code> error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.SolutionStackName"> <summary> <para> <para> This specifies the platform version that the environment will run after the environment is updated. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EB.UpdateEBEnvironmentCmdlet.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.EFS.EditEFSMountTargetSecurityGroupCmdlet"> <summary> Modifies the set of security groups in effect for a mount target. <para> When you create a mount target, Amazon EFS also creates a new network interface (see <a>CreateMountTarget</a>). This operation replaces the security groups in effect for the network interface associated with a mount target, with the <code>SecurityGroups</code> provided in the request. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not "deleted". </para><para> The operation requires permissions for the following actions: </para><ul><li><code>elasticfilesystem:ModifyMountTargetSecurityGroups</code> action on the mount target's file system. </li><li><code>ec2:ModifyNetworkInterfaceAttribute</code> action on the mount target's network interface. </li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.MountTargetId"> <summary> <para> <para>The ID of the mount target whose security groups you want to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.SecurityGroup"> <summary> <para> <para>An array of up to five VPC security group IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.PassThru"> <summary> Returns the value passed to the SecurityGroup parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.EditEFSMountTargetSecurityGroupCmdlet.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.EFS.GetEFSFileSystemCmdlet"> <summary> Returns the description of a specific Amazon EFS file system if either the file system <code>CreationToken</code> or the <code>FileSystemId</code> is provided; otherwise, returns descriptions of all file systems owned by the caller's AWS account in the AWS region of the endpoint that you're calling. <para> When retrieving all file system descriptions, you can optionally specify the <code>MaxItems</code> parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a <code>NextMarker</code>, an opaque token, in the response. In this case, you should send a subsequent request with the <code>Marker</code> request parameter set to the value of <code>NextMarker</code>. </para><para> So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling <code>DescribeFileSystems</code> without the <code>Marker</code> and then continuing to call it with the <code>Marker</code> parameter set to the value of the <code>NextMarker</code> from the previous response until the response has no <code>NextMarker</code>. </para><para> Note that the implementation may return fewer than <code>MaxItems</code> file system descriptions while still including a <code>NextMarker</code> value. </para><para> The order of file systems returned in the response of one <code>DescribeFileSystems</code> call, and the order of file systems returned across the responses of a multi-call iteration, is unspecified. </para><para> This operation requires permission for the <code>elasticfilesystem:DescribeFileSystems</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.CreationToken"> <summary> <para> <para> Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.FileSystemId"> <summary> <para> <para>Optional string. File system ID whose description you want to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.Marker"> <summary> <para> <para> Optional string. Opaque pagination token returned from a previous <code>DescribeFileSystems</code> operation. If present, specifies to continue the list from where the returning call had left off. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSFileSystemCmdlet.MaxItem"> <summary> <para> <para>Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the <code>MaxItems</code> parameter specified in the request and the service's internal maximum number of items per page. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet"> <summary> Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeMountTargets</code> action, on either the file system id that you specify in <code>FileSystemId</code>, or on the file system of the mount target that you specify in <code>MountTargetId</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.FileSystemId"> <summary> <para> <para>Optional. String. The ID of the file system whose mount targets you want to list. It must be included in your request if <code>MountTargetId</code> is not included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.MountTargetId"> <summary> <para> <para>Optional. String. The ID of the mount target that you want to have described. It must be included in your request if <code>FileSystemId</code> is not included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.Marker"> <summary> <para> <para>Optional. String. Opaque pagination token returned from a previous <code>DescribeMountTargets</code> operation. If present, it specifies to continue the list from where the previous returning call left off.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetCmdlet.MaxItem"> <summary> <para> <para>Optional. Maximum number of mount targets to return in the response. It must be an integer with a value greater than zero.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetSecurityGroupCmdlet"> <summary> Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not "deleted". <para> This operation requires permissions for the following actions: </para><ul><li><code>elasticfilesystem:DescribeMountTargetSecurityGroups</code> action on the mount target's file system. </li><li><code>ec2:DescribeNetworkInterfaceAttribute</code> action on the mount target's network interface. </li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSMountTargetSecurityGroupCmdlet.MountTargetId"> <summary> <para> <para>The ID of the mount target whose security groups you want to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet"> <summary> Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call, and the order of tags returned across the responses of a multi-call iteration (when using pagination), is unspecified. <para> This operation requires permission for the <code>elasticfilesystem:DescribeTags</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system whose tag set you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.Marker"> <summary> <para> <para>Optional. String. Opaque pagination token returned from a previous <code>DescribeTags</code> operation. If present, it specifies to continue the list from where the previous call left off.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.GetEFSTagCmdlet.MaxItem"> <summary> <para> <para>Optional. Maximum number of file system tags to return in the response. It must be an integer with a value greater than zero.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet"> <summary> Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: <ul><li>Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state "creating". </li><li> Returns with the description of the created file system. </li></ul><para> Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system. </para><note>For basic use cases, you can use a randomly generated UUID for the creation token.</note><para> The idempotent operation allows you to retry a <code>CreateFileSystem</code> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <code>FileSystemAlreadyExists</code> error. </para><note>The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still "creating". You can check the file system creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the file system state.</note><para> After the file system is fully created, Amazon EFS sets its lifecycle state to "available", at which point you can create one or more mount targets for the file system (<a>CreateMountTarget</a>) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a></para><para> This operation requires permission for the <code>elasticfilesystem:CreateFileSystem</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.CreationToken"> <summary> <para> <para>String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSFileSystemCmdlet.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.EFS.NewEFSMountTargetCmdlet"> <summary> Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target. <para> You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html">Amazon EFS: How it Works</a>. </para><para> In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be "available" (see <a>DescribeFileSystems</a>). </para><para> In the request, you also provide a subnet ID, which serves several purposes: </para><ul><li>It determines the VPC in which Amazon EFS creates the mount target.</li><li>It determines the Availability Zone in which Amazon EFS creates the mount target. </li><li>It determines the IP address range from which Amazon EFS selects the IP address of the mount target if you don't specify an IP address in the request. </li></ul><para> After creating the mount target, Amazon EFS returns a response that includes, a <code>MountTargetId</code> and an <code>IpAddress</code>. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see <a href="http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation">How it Works: Implementation Overview</a>. </para><para> Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the request to add another mount target must meet the following requirements: </para><ul><li><para> The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets. </para></li><li>The subnet specified in the request must not be in the same Availability Zone as any of the subnets of the existing mount targets.</li></ul><para> If the request satisfies the requirements, Amazon EFS does the following: </para><ul><li>Creates a new mount target in the specified subnet. </li><li>Also creates a new network interface in the subnet as follows: <ul><li>If the request provides an <code>IpAddress</code>, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 <code>CreateNetworkInterface</code> call does when a request does not specify a primary private IP address).</li><li>If the request provides <code>SecurityGroups</code>, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.</li><li>Assigns the description <code>"Mount target <i>fsmt-id</i> for file system <i>fs-id</i>"</code> where <code><i>fsmt-id</i></code> is the mount target ID, and <code><i>fs-id</i></code> is the <code>FileSystemId</code>.</li><li>Sets the <code>requesterManaged</code> property of the network interface to "true", and the <code>requesterId</code> value to "EFS".</li></ul><para> Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the <code>NetworkInterfaceId</code> field in the mount target's description to the network interface ID, and the <code>IpAddress</code> field to its address. If network interface creation fails, the entire <code>CreateMountTarget</code> operation fails. </para></li></ul><note>The <code>CreateMountTarget</code> call returns only after creating the network interface, but while the mount target state is still "creating". You can check the mount target creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the mount target state.</note><para> We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, go to <a href="http://aws.amazon.com/efs/">Amazon EFS</a> product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target. </para><para> This operation requires permission for the following action on the file system: </para><ul><li><code>elasticfilesystem:CreateMountTarget</code></li></ul><para> This operation also requires permission for the following Amazon EC2 actions: </para><ul><li><code>ec2:DescribeSubnets</code></li><li><code>ec2:DescribeNetworkInterfaces</code></li><li><code>ec2:CreateNetworkInterface</code></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system for which to create the mount target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.IpAddress"> <summary> <para> <para>A valid IPv4 address within the address range of the specified subnet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.SecurityGroup"> <summary> <para> <para> Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.SubnetId"> <summary> <para> <para>The ID of the subnet to add the mount target in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSMountTargetCmdlet.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.EFS.NewEFSTagCmdlet"> <summary> Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the "Name" tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> API. <para> This operation requires permission for the <code>elasticfilesystem:CreateTags</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.FileSystemId"> <summary> <para> <para>String. The ID of the file system whose tags you want to modify. This operation modifies only the tags and not the file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.Tag"> <summary> <para> <para> An array of <code>Tag</code> objects to add. Each <code>Tag</code> object is a key-value pair. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.PassThru"> <summary> Returns the value passed to the Tag parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.NewEFSTagCmdlet.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.EFS.RemoveEFSFileSystemCmdlet"> <summary> Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system. <para> You cannot delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </para><note>The <code>DeleteFileSystem</code> call returns while the file system state is still "deleting". You can check the file system deletion status by calling the <a>DescribeFileSystems</a> API, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> will return a 404 "FileSystemNotFound" error.</note><para> This operation requires permission for the <code>elasticfilesystem:DeleteFileSystem</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemCmdlet.FileSystemId"> <summary> <para> <para>The ID of the file system you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemCmdlet.PassThru"> <summary> Returns the value passed to the FileSystemId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSFileSystemCmdlet.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.EFS.RemoveEFSMountTargetCmdlet"> <summary> Deletes the specified mount target. <para> This operation forcibly breaks any mounts of the file system via the mount target being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC using another mount target. </para><para> This operation requires permission for the following action on the file system: </para><ul><li><code>elasticfilesystem:DeleteMountTarget</code></li></ul><note>The <code>DeleteMountTarget</code> call returns while the mount target state is still "deleting". You can check the mount target deletion by calling the <a>DescribeMountTargets</a> API, which returns a list of mount target descriptions for the given file system. </note><para> The operation also requires permission for the following Amazon EC2 action on the mount target's network interface: </para><ul><li><code>ec2:DeleteNetworkInterface</code></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSMountTargetCmdlet.MountTargetId"> <summary> <para> <para>String. The ID of the mount target to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSMountTargetCmdlet.PassThru"> <summary> Returns the value passed to the MountTargetId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSMountTargetCmdlet.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.EFS.RemoveEFSTagCmdlet"> <summary> Deletes the specified tags from a file system. If the <code>DeleteTags</code> request includes a tag key that does not exist, Amazon EFS ignores it; it is not an error. For more information about tags and related restrictions, go to <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>. <para> This operation requires permission for the <code>elasticfilesystem:DeleteTags</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.FileSystemId"> <summary> <para> <para>String. The ID of the file system whose tags you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.PassThru"> <summary> Returns the value passed to the FileSystemId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EFS.RemoveEFSTagCmdlet.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.ELB.AddELBLoadBalancerToSubnetCmdlet"> <summary> Adds one or more subnets to the set of configured subnets for the specified load balancer. <para> The load balancer evenly distributes requests across all registered subnets. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html">Elastic Load Balancing in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.AddELBLoadBalancerToSubnetCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.AddELBLoadBalancerToSubnetCmdlet.Subnet"> <summary> <para> <para>The IDs of the subnets to add for the load balancer. You can add only one subnet per Availability Zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.AddELBLoadBalancerToSubnetCmdlet.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.ELB.AddELBTagsCmdlet"> <summary> Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags. <para> Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, <code>AddTags</code> updates its value. </para><para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#tagging-elb">Tagging</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.AddELBTagsCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer. You can specify one load balancer only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.AddELBTagsCmdlet.Tag"> <summary> <para> <para>The tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.AddELBTagsCmdlet.PassThru"> <summary> Returns the collection of Tag objects that were added. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.AddELBTagsCmdlet.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.ELB.DisableELBAvailabilityZoneForLoadBalancerCmdlet"> <summary> Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer. <para> There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the <code>OutOfService</code> state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones. </para><para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_ShrinkLBApp04.html">Disable an Availability Zone from a Load-Balanced Application</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.DisableELBAvailabilityZoneForLoadBalancerCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zones.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.DisableELBAvailabilityZoneForLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.DisableELBAvailabilityZoneForLoadBalancerCmdlet.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.ELB.DismountELBLoadBalancerFromSubnetCmdlet"> <summary> Removes the specified subnets from the set of configured subnets for the load balancer. <para> After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the <code>OutOfService</code> state. Then, the load balancer balances the traffic among the remaining routable subnets. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.DismountELBLoadBalancerFromSubnetCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.DismountELBLoadBalancerFromSubnetCmdlet.Subnet"> <summary> <para> <para>The IDs of the subnets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.DismountELBLoadBalancerFromSubnetCmdlet.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.ELB.EditELBLoadBalancerAttributeCmdlet"> <summary> Modifies the attributes of the specified load balancer. <para> You can modify the load balancer attributes, such as <code>AccessLogs</code>, <code>ConnectionDraining</code>, and <code>CrossZoneLoadBalancing</code> by either enabling or disabling them. Or, you can modify the load balancer attribute <code>ConnectionSettings</code> by specifying an idle connection timeout value for your load balancer. </para><para> For more information, see the following in the <i>Elastic Load Balancing Developer Guide</i>: </para><ul><li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#request-routing">Cross-Zone Load Balancing</a></li><li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a></li><li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/access-log-collection.html">Access Logs</a></li><li><a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#idle-timeout">Idle Connection Timeout</a></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.LoadBalancerAttributes_AdditionalAttribute"> <summary> <para> <para>This parameter is reserved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.AccessLog_EmitInterval"> <summary> <para> <para>The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.</para><para>Default: 60 minutes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.AccessLog_Enabled"> <summary> <para> <para>Specifies whether access log is enabled for the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.ConnectionDraining_Enabled"> <summary> <para> <para>Specifies whether connection draining is enabled for the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.CrossZoneLoadBalancing_Enabled"> <summary> <para> <para>Specifies whether cross-zone load balancing is enabled for the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.ConnectionSettings_IdleTimeout"> <summary> <para> <para>The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.AccessLog_S3BucketName"> <summary> <para> <para>The name of the Amazon S3 bucket where the access logs are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.AccessLog_S3BucketPrefix"> <summary> <para> <para>The logical hierarchy you created for your Amazon S3 bucket, for example <code>my-bucket-prefix/prod</code>. If the prefix is not provided, the log is placed at the root level of the bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.ConnectionDraining_Timeout"> <summary> <para> <para>The maximum time, in seconds, to keep the existing connections open before deregistering the instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EditELBLoadBalancerAttributeCmdlet.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.ELB.EnableELBAvailabilityZoneForLoadBalancerCmdlet"> <summary> Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer. <para> The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. </para><para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_AddLBAvailabilityZone.html">Add Availability Zone</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EnableELBAvailabilityZoneForLoadBalancerCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zones. These must be in the same region as the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EnableELBAvailabilityZoneForLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.EnableELBAvailabilityZoneForLoadBalancerCmdlet.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.ELB.GetELBInstanceHealthCmdlet"> <summary> Describes the state of the specified instances registered with the specified load balancer. If no instances are specified, the call describes the state of all instances registered with the load balancer, not including any terminated instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBInstanceHealthCmdlet.Instance"> <summary> <para> <para>The IDs of the instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBInstanceHealthCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerCmdlet"> <summary> Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The names of the load balancers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerCmdlet.PageSize"> <summary> <para> <para>The maximum number of results to return with this call (a number from 1 to 400). The default is 400.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results. (You received this marker from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerAttributeCmdlet"> <summary> Describes the attributes for the specified load balancer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerAttributeCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerPolicyCmdlet"> <summary> Describes the specified policies. <para> If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the <code>ELBSample-</code> prefix. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerPolicyCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerPolicyCmdlet.PolicyName"> <summary> <para> <para>The names of the policies.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerPolicyTypeCmdlet"> <summary> Describes the specified load balancer policy types. <para> You can use these policy types with <a>CreateLoadBalancerPolicy</a> to create policy configurations for a load balancer. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBLoadBalancerPolicyTypeCmdlet.PolicyTypeName"> <summary> <para> <para>The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ELB.GetELBTagsCmdlet"> <summary> Describes the tags associated with the specified load balancers. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.GetELBTagsCmdlet.LoadBalancerName"> <summary> <para> <para>The names of the load balancers.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ELB.JoinELBSecurityGroupToLoadBalancerCmdlet"> <summary> Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/USVPC_ApplySG.html">Manage Security Groups for Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.JoinELBSecurityGroupToLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.JoinELBSecurityGroupToLoadBalancerCmdlet.SecurityGroup"> <summary> <para> <para>The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.JoinELBSecurityGroupToLoadBalancerCmdlet.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.ELB.NewELBAppCookieStickinessPolicyCmdlet"> <summary> Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners. <para> This policy is similar to the policy created by <a>CreateLBCookieStickinessPolicy</a>, except that the lifetime of the special Elastic Load Balancing cookie, <code>AWSELB</code>, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie. </para><para> If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued. </para><para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_StickySessions.html#US_EnableStickySessionsAppCookies">Application-Controlled Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBAppCookieStickinessPolicyCmdlet.CookieName"> <summary> <para> <para>The name of the application cookie used for stickiness.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBAppCookieStickinessPolicyCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBAppCookieStickinessPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy being created. This name must be unique within the set of policies for this load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBAppCookieStickinessPolicyCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBAppCookieStickinessPolicyCmdlet.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.ELB.NewELBLBCookieStickinessPolicyCmdlet"> <summary> Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. <para> When a load balancer implements this policy, the load balancer uses a special cookie to track the back-end server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm. </para><para> A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration. </para><para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_StickySessions.html#US_EnableStickySessionsLBCookies">Duration-Based Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLBCookieStickinessPolicyCmdlet.CookieExpirationPeriod"> <summary> <para> <para>The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the sticky session lasts for the duration of the browser session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLBCookieStickinessPolicyCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLBCookieStickinessPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy being created. This name must be unique within the set of policies for this load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLBCookieStickinessPolicyCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLBCookieStickinessPolicyCmdlet.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.ELB.NewELBLoadBalancerCmdlet"> <summary> Creates a load balancer. <para> If the call completes successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balancer was created. For example, the DNS name might end with either of the following: </para><ul><li><code>us-east-1.elb.amazonaws.com</code></li><li><code>us-west-2.elb.amazonaws.com</code></li></ul><para> For information about the AWS regions supported by Elastic Load Balancing, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region">Regions and Endpoints</a> in the <i>Amazon Web Services General Reference</i>. </para><para> You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-limits.html">Elastic Load Balancing Limits</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para><para> Elastic Load Balancing supports load balancing your EC2 instances launched in either the EC2-Classic or EC2-VPC platform. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForEC2.html">Elastic Load Balancing in EC2-Classic</a> or <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html">Elastic Load Balancing in a VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerCmdlet.AvailabilityZone"> <summary> <para> <para>One or more Availability Zones from the same region as the load balancer. Traffic is equally distributed across all specified Availability Zones.</para><para>You must specify at least one Availability Zone.</para><para>You can add more Availability Zones after you create the load balancer using <a>EnableAvailabilityZonesForLoadBalancer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerCmdlet.Listener"> <summary> <para> <para>The listeners.</para><para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-listener-config.html">Listener Configurations for Elastic Load Balancing</a> in the <i>Elastic Load Balancing Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para><para>This name must be unique within your AWS account, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerCmdlet.Scheme"> <summary> <para> <para>The type of a load balancer. Valid only for load balancers in a VPC.</para><para>By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/vpc-loadbalancer-types.html">Internet-facing and Internal Load Balancers</a> in the <i>Elastic Load Balancing Developer Guide</i>.</para><para>Specify <code>internal</code> to create an internal load balancer with a DNS name that resolves to private IP addresses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerCmdlet.SecurityGroup"> <summary> <para> <para>The IDs of the security groups to assign to the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerCmdlet.Subnet"> <summary> <para> <para>The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in <code>AvailabilityZones</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerCmdlet.Tag"> <summary> <para> <para>A list of tags to assign to the load balancer.</para><para>For more information about tagging your load balancer, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#tagging-elb">Tagging</a> in the <i>Elastic Load Balancing Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerCmdlet.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.ELB.NewELBLoadBalancerListenerCmdlet"> <summary> Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/us-add-listener.html">Add a Listener to Your Load Balancer</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerListenerCmdlet.Listener"> <summary> <para> <para>The listeners.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerListenerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerListenerCmdlet.PassThru"> <summary> Returns the collection of Listener objects that were created. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerListenerCmdlet.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.ELB.NewELBLoadBalancerPolicyCmdlet"> <summary> Creates a policy with the specified attributes for the specified load balancer. <para> Policies are settings that are saved for your load balancer and that can be applied to the front-end listener or the back-end application server, depending on the policy type. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerPolicyCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerPolicyCmdlet.PolicyAttribute"> <summary> <para> <para>The attributes for the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerPolicyCmdlet.PolicyTypeName"> <summary> <para> <para>The name of the base policy type. To get the list of policy types, use <a>DescribeLoadBalancerPolicyTypes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerPolicyCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.NewELBLoadBalancerPolicyCmdlet.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.ELB.RegisterELBInstanceWithLoadBalancerCmdlet"> <summary> Adds the specified instances to the specified load balancer. <para> The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC. </para><para> Note that <code>RegisterInstanceWithLoadBalancer</code> completes when the request has been registered. Instance registration happens shortly afterwards. To check the state of the registered instances, use <a>DescribeLoadBalancers</a> or <a>DescribeInstanceHealth</a>. </para><para> After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the <code>OutOfService</code> state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the <code>InService</code> state. </para><para> If you stop an instance registered with a load balancer and then start it, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use <a>DeregisterInstancesFromLoadBalancer</a>. </para><para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">Deregister and Register EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RegisterELBInstanceWithLoadBalancerCmdlet.Instance"> <summary> <para> <para>The IDs of the instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RegisterELBInstanceWithLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RegisterELBInstanceWithLoadBalancerCmdlet.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.ELB.RemoveELBInstanceFromLoadBalancerCmdlet"> <summary> Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer. <para> You can use <a>DescribeLoadBalancers</a> to verify that the instance is deregistered from the load balancer. </para><para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">Deregister and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBInstanceFromLoadBalancerCmdlet.Instance"> <summary> <para> <para>The IDs of the instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBInstanceFromLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBInstanceFromLoadBalancerCmdlet.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.ELB.RemoveELBLoadBalancerCmdlet"> <summary> Deletes the specified load balancer. <para> If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to back-end instances. </para><para> If the load balancer does not exist or has already been deleted, the call to <code>DeleteLoadBalancer</code> still succeeds. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerCmdlet.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.ELB.RemoveELBLoadBalancerListenerCmdlet"> <summary> Deletes the specified listeners from the specified load balancer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerListenerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerListenerCmdlet.LoadBalancerPort"> <summary> <para> <para>The client port numbers of the listeners.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerListenerCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerListenerCmdlet.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.ELB.RemoveELBLoadBalancerPolicyCmdlet"> <summary> Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerPolicyCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerPolicyCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBLoadBalancerPolicyCmdlet.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.ELB.RemoveELBTagsCmdlet"> <summary> Removes one or more tags from the specified load balancer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBTagsCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer. You can specify a maximum of one load balancer name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBTagsCmdlet.Tag"> <summary> <para> <para>The list of tag keys to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBTagsCmdlet.PassThru"> <summary> Returns the collection of tag keys that were removed. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.RemoveELBTagsCmdlet.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.ELB.SetELBHealthCheckCmdlet"> <summary> Specifies the health check settings to use when evaluating the health state of your back-end instances. <para> For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#healthcheck">Health Checks</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBHealthCheckCmdlet.HealthCheck_HealthyThreshold"> <summary> <para> <para>The number of consecutive health checks successes required before moving the instance to the <code>Healthy</code> state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBHealthCheckCmdlet.HealthCheck_Interval"> <summary> <para> <para>The approximate interval, in seconds, between health checks of an individual instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBHealthCheckCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBHealthCheckCmdlet.HealthCheck_Target"> <summary> <para> <para>The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.</para><para>TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.</para><para>SSL is also specified as SSL: port pair, for example, SSL:5000.</para><para>For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.</para><para>The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBHealthCheckCmdlet.HealthCheck_Timeout"> <summary> <para> <para>The amount of time, in seconds, during which no response means a failed health check.</para><para>This value must be less than the <code>Interval</code> value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBHealthCheckCmdlet.HealthCheck_UnhealthyThreshold"> <summary> <para> <para>The number of consecutive health check failures required before moving the instance to the <code>Unhealthy</code> state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBHealthCheckCmdlet.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.ELB.SetELBLoadBalancerListenerSSLCertificateCmdlet"> <summary> Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port. <para> For more information about updating your SSL certificate, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_UpdatingLoadBalancerSSL.html">Updating an SSL Certificate for a Load Balancer</a> in the <i>Elastic Load Balancing Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerListenerSSLCertificateCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerListenerSSLCertificateCmdlet.LoadBalancerPort"> <summary> <para> <para>The port that uses the specified SSL certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerListenerSSLCertificateCmdlet.SSLCertificateId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SSL certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerListenerSSLCertificateCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerListenerSSLCertificateCmdlet.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.ELB.SetELBLoadBalancerPolicyForBackendServerCmdlet"> <summary> Replaces the set of policies associated with the specified port on which the back-end server is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies. <para> Each time you use <code>SetLoadBalancerPoliciesForBackendServer</code> to enable the policies, use the <code>PolicyNames</code> parameter to list the policies that you want to enable. </para><para> You can use <a>DescribeLoadBalancers</a> or <a>DescribeLoadBalancerPolicies</a> to verify that the policy is associated with the back-end server. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyForBackendServerCmdlet.InstancePort"> <summary> <para> <para>The port number associated with the back-end server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyForBackendServerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyForBackendServerCmdlet.PolicyName"> <summary> <para> <para>The names of the policies. If the list is empty, then all current polices are removed from the back-end server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyForBackendServerCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyForBackendServerCmdlet.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.ELB.SetELBLoadBalancerPolicyOfListenerCmdlet"> <summary> Associates, updates, or disables a policy with a listener for the specified load balancer. You can associate multiple policies with a listener. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyOfListenerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyOfListenerCmdlet.LoadBalancerPort"> <summary> <para> <para>The external port of the load balancer for the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyOfListenerCmdlet.PolicyName"> <summary> <para> <para>The names of the policies. If the list is empty, the current policy is removed from the listener.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyOfListenerCmdlet.PassThru"> <summary> Returns the value passed to the LoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ELB.SetELBLoadBalancerPolicyOfListenerCmdlet.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.EMR.AddEMRInstanceGroupCmdlet"> <summary> AddInstanceGroups adds an instance group to a running cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRInstanceGroupCmdlet.InstanceGroup"> <summary> <para> <para>Instance Groups to add.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRInstanceGroupCmdlet.JobFlowId"> <summary> <para> <para>Job flow in which to add the instance groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRInstanceGroupCmdlet.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.EMR.AddEMRJobFlowStepCmdlet"> <summary> AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed in each job flow. <para> If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/AddMoreThan256Steps.html">Add More than 256 Steps to a Job Flow</a> in the <i>Amazon Elastic MapReduce Developer's Guide</i>. </para><para> A step specifies the location of a JAR file stored either on the master node of the job flow or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step. </para><para> Elastic MapReduce executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully. </para><para> You can only add steps to a job flow that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRJobFlowStepCmdlet.JobFlowId"> <summary> <para> <para>A string that uniquely identifies the job flow. This identifier is returned by <a>RunJobFlow</a> and can also be obtained from <a>ListClusters</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRJobFlowStepCmdlet.Step"> <summary> <para> <para> A list of <a>StepConfig</a> to be executed by the job flow. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRJobFlowStepCmdlet.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.EMR.AddEMRTagCmdlet"> <summary> Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-plan-tags.html">Tagging Amazon EMR Resources</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRTagCmdlet.ResourceId"> <summary> <para> <para>The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRTagCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with a cluster and propagate to Amazon EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRTagCmdlet.PassThru"> <summary> Returns the collection of Tag objects that were added. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.AddEMRTagCmdlet.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.EMR.EditEMRInstanceGroupCmdlet"> <summary> ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.EditEMRInstanceGroupCmdlet.InstanceGroup"> <summary> <para> <para>Instance groups to change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.EditEMRInstanceGroupCmdlet.PassThru"> <summary> Returns the value passed to the InstanceGroup parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.EditEMRInstanceGroupCmdlet.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.EMR.GetEMRBootstrapActionsCmdlet"> <summary> Provides information about the bootstrap actions associated with a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRBootstrapActionsCmdlet.ClusterId"> <summary> <para> <para>The cluster identifier for the bootstrap actions to list .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRBootstrapActionsCmdlet.Marker"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve .</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EMR.GetEMRClusterCmdlet"> <summary> Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see <a>ListSteps</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRClusterCmdlet.ClusterId"> <summary> <para> <para>The identifier of the cluster to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EMR.GetEMRClustersCmdlet"> <summary> Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRClustersCmdlet.ClusterState"> <summary> <para> <para>The cluster state filters to apply when listing clusters. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRClustersCmdlet.CreatedAfter"> <summary> <para> <para>The creation date and time beginning value filter for listing clusters .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRClustersCmdlet.CreatedBefore"> <summary> <para> <para>The creation date and time end value filter for listing clusters .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRClustersCmdlet.Marker"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EMR.GetEMRInstanceGroupCmdlet"> <summary> Provides all available details about the instance groups in a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRInstanceGroupCmdlet.ClusterId"> <summary> <para> <para>The identifier of the cluster for which to list the instance groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRInstanceGroupCmdlet.Marker"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EMR.GetEMRInstancesCmdlet"> <summary> Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRInstancesCmdlet.ClusterId"> <summary> <para> <para>The identifier of the cluster for which to list the instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRInstancesCmdlet.InstanceGroupId"> <summary> <para> <para>The identifier of the instance group for which to list the instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRInstancesCmdlet.InstanceGroupType"> <summary> <para> <para>The type of instance group for which to list the instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRInstancesCmdlet.Marker"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EMR.GetEMRJobFlowCmdlet"> <summary> This API is deprecated and will eventually be removed. We recommend you use <a>ListClusters</a>, <a>DescribeCluster</a>, <a>ListSteps</a>, <a>ListInstanceGroups</a> and <a>ListBootstrapActions</a> instead. <para> DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time. </para><para> Regardless of supplied parameters, only job flows created within the last two months are returned. </para><para> If no parameters are supplied, then job flows matching either of the following criteria are returned: </para><ul><li>Job flows created and completed in the last two weeks</li><li> Job flows created within the last two months that are in one of the following states: <code>RUNNING</code>, <code>WAITING</code>, <code>SHUTTING_DOWN</code>, <code>STARTING</code></li></ul><para> Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRJobFlowCmdlet.CreatedAfter"> <summary> <para> <para>Return only job flows created after this date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRJobFlowCmdlet.CreatedBefore"> <summary> <para> <para>Return only job flows created before this date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRJobFlowCmdlet.JobFlowId"> <summary> <para> <para>Return only job flows whose job flow ID is contained in this list. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRJobFlowCmdlet.JobFlowState"> <summary> <para> <para>Return only job flows whose state is contained in this list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EMR.GetEMRStepCmdlet"> <summary> Provides more detail about the cluster step. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRStepCmdlet.ClusterId"> <summary> <para> <para>The identifier of the cluster with steps to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRStepCmdlet.StepId"> <summary> <para> <para>The identifier of the step to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EMR.GetEMRStepsCmdlet"> <summary> Provides a list of steps for the cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRStepsCmdlet.ClusterId"> <summary> <para> <para>The identifier of the cluster for which to list the steps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRStepsCmdlet.StepId"> <summary> <para> <para>The filter to limit the step list based on the identifier of the steps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRStepsCmdlet.StepState"> <summary> <para> <para>The filter to limit the step list based on certain states.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.GetEMRStepsCmdlet.Marker"> <summary> <para> <para>The pagination token that indicates the next set of results to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.EMR.RemoveEMRTagCmdlet"> <summary> Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-plan-tags.html">Tagging Amazon EMR Resources</a>. <para> The following example removes the stack tag with value Prod from a cluster: </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.RemoveEMRTagCmdlet.ResourceId"> <summary> <para> <para>The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.RemoveEMRTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to remove from a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.RemoveEMRTagCmdlet.PassThru"> <summary> Returns the collection of Tag keys that were removed. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.RemoveEMRTagCmdlet.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.EMR.SetEMRTerminationProtectionCmdlet"> <summary> SetTerminationProtection locks a job flow so the Amazon EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a job flow is analogous to calling the Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster. <para> SetTerminationProtection is used to prevent accidental termination of a job flow and to ensure that in the event of an error, the instances will persist so you can recover any data stored in their ephemeral instance storage. </para><para> To terminate a job flow that has been locked by setting SetTerminationProtection to <code>true</code>, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to <code>false</code>. </para><para> For more information, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/UsingEMR_TerminationProtection.html">Protecting a Job Flow from Termination</a> in the <i>Amazon Elastic MapReduce Developer's Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.SetEMRTerminationProtectionCmdlet.JobFlowId"> <summary> <para> <para> A list of strings that uniquely identify the job flows to protect. This identifier is returned by <a>RunJobFlow</a> and can also be obtained from <a>DescribeJobFlows</a> . </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.SetEMRTerminationProtectionCmdlet.TerminationProtected"> <summary> <para> <para> A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.SetEMRTerminationProtectionCmdlet.PassThru"> <summary> Returns the value passed to the JobFlowId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.SetEMRTerminationProtectionCmdlet.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.EMR.SetEMRVisibleToAllUsersCmdlet"> <summary> Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified job flows. This action works on running job flows. You can also set the visibility of a job flow when you launch it using the <code>VisibleToAllUsers</code> parameter of <a>RunJobFlow</a>. The SetVisibleToAllUsers action can be called only by an IAM user who created the job flow or the AWS account that owns the job flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.SetEMRVisibleToAllUsersCmdlet.JobFlowId"> <summary> <para> <para>Identifiers of the job flows to receive the new visibility setting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.SetEMRVisibleToAllUsersCmdlet.VisibleToAllUser"> <summary> <para> <para>Whether the specified job flows are visible to all IAM users of the AWS account associated with the job flow. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the job flows. If it is set to False, only the IAM user that created a job flow can view and manage it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.SetEMRVisibleToAllUsersCmdlet.PassThru"> <summary> Returns the value passed to the JobFlowId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.SetEMRVisibleToAllUsersCmdlet.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.EMR.StartEMRJobFlowCmdlet"> <summary> RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. Once the job flow completes, the cluster is stopped and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the <a>JobFlowInstancesConfig</a><code>KeepJobFlowAliveWhenNoSteps</code> parameter is set to <code>TRUE</code>, the job flow will transition to the WAITING state rather than shutting down once the steps have completed. <para> For additional protection, you can set the <a>JobFlowInstancesConfig</a><code>TerminationProtected</code> parameter to <code>TRUE</code> to lock the job flow and prevent it from being terminated by API call, user intervention, or in the event of a job flow error. </para><para> A maximum of 256 steps are allowed in each job flow. </para><para> If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/AddMoreThan256Steps.html">Add More than 256 Steps to a Job Flow</a> in the <i>Amazon Elastic MapReduce Developer's Guide</i>. </para><para> For long running job flows, we recommend that you periodically store your results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.AdditionalInfo"> <summary> <para> <para>A JSON string for selecting additional features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_AdditionalMasterSecurityGroup"> <summary> <para> <para>A list of additional Amazon EC2 security group IDs for the master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_AdditionalSlaveSecurityGroup"> <summary> <para> <para>A list of additional Amazon EC2 security group IDs for the slave nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.AmiVersion"> <summary> <para> <note><para>For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.</para></note><para>The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid: </para><ul><li>The version number of the AMI to use, for example, "2.0."</li></ul><para>If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the <a>JobFlowInstancesConfig</a><code>HadoopVersion</code> parameter to modify the version of Hadoop from the defaults shown above.</para><para>For details about the AMI versions currently supported by Amazon Elastic MapReduce, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/EnvironmentConfig_AMIVersion.html#ami-versions-supported">AMI Versions Supported in Elastic MapReduce</a> in the <i>Amazon Elastic MapReduce Developer's Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Application"> <summary> <para> <note><para>Amazon EMR releases 4.x or later.</para></note><para>A list of applications for the cluster. Valid values are: "Hadoop", "Hive", "Mahout", "Pig", and "Spark." They are case insensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Placement_AvailabilityZone"> <summary> <para> <para>The Amazon EC2 Availability Zone for the job flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.BootstrapAction"> <summary> <para> <para> A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Configuration"> <summary> <para> <note><para>Amazon EMR releases 4.x or later.</para></note><para>The list of configurations supplied for the EMR cluster you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_Ec2KeyName"> <summary> <para> <para>The name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_Ec2SubnetId"> <summary> <para> <para> To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC. </para><para> Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_EmrManagedMasterSecurityGroup"> <summary> <para> <para>The identifier of the Amazon EC2 security group (managed by Amazon ElasticMapReduce) for the master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_EmrManagedSlaveSecurityGroup"> <summary> <para> <para>The identifier of the Amazon EC2 security group (managed by Amazon ElasticMapReduce) for the slave nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_HadoopVersion"> <summary> <para> <para>The Hadoop version for the job flow. Valid inputs are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_InstanceCount"> <summary> <para> <para>The number of Amazon EC2 instances used to execute the job flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_InstanceGroup"> <summary> <para> <para>Configuration for the job flow's instance groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.JobFlowRole"> <summary> <para> <para>An IAM role for the job flow. The EC2 instances of the job flow assume this role. The default role is <code>EMRJobflowDefault</code>. In order to use the default role, you must have already created it using the CLI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_KeepJobFlowAliveWhenNoStep"> <summary> <para> <para>Specifies whether the job flow should be kept alive after completing all steps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.LogUri"> <summary> <para> <para>The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_MasterInstanceType"> <summary> <para> <para>The EC2 instance type of the master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Name"> <summary> <para> <para>The name of the job flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.NewSupportedProduct"> <summary> <para> <note><para>For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.</para></note><para>A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-mapr.html">Launch a Job Flow on the MapR Distribution for Hadoop</a>. Currently supported values are:</para><ul><li>"mapr-m3" - launch the cluster using MapR M3 Edition.</li><li>"mapr-m5" - launch the cluster using MapR M5 Edition.</li><li>"mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.</li><li>"mapr-m7" - launch the cluster using MapR M7 Edition.</li><li>"hunk" - launch the cluster with the Hunk Big Data Analtics Platform.</li><li>"hue"- launch the cluster with Hue installed.</li><li>"spark" - launch the cluster with Apache Spark installed.</li><li>"ganglia" - launch the cluster with the Ganglia Monitoring System installed.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.ReleaseLabel"> <summary> <para> <note><para>Amazon EMR releases 4.x or later.</para></note><para>The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.ServiceRole"> <summary> <para> <para>The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_SlaveInstanceType"> <summary> <para> <para>The EC2 instance type of the slave nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Step"> <summary> <para> <para>A list of steps to be executed by the job flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.SupportedProduct"> <summary> <para> <note><para>For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.</para></note><para>A list of strings that indicates third-party software to use with the job flow. For more information, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-supported-products.html">Use Third Party Applications with Amazon EMR</a>. Currently supported values are:</para><ul><li>"mapr-m3" - launch the job flow using MapR M3 Edition.</li><li>"mapr-m5" - launch the job flow using MapR M5 Edition.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with a cluster and propagate to Amazon EC2 instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.Instances_TerminationProtected"> <summary> <para> <para>Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.VisibleToAllUser"> <summary> <para> <para>Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to <code>true</code>, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to <code>false</code>, only the IAM user that created the job flow can view and manage it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StartEMRJobFlowCmdlet.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.EMR.StopEMRJobFlowCmdlet"> <summary> TerminateJobFlows shuts a list of job flows down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the job flow is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the job flow was created. <para> The maximum number of JobFlows allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, it may take up to 5-20 minutes for the job flow to completely terminate and release allocated resources, such as Amazon EC2 instances. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StopEMRJobFlowCmdlet.JobFlowId"> <summary> <para> <para>A list of job flows to be shutdown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StopEMRJobFlowCmdlet.PassThru"> <summary> Returns the value passed to the JobFlowId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMR.StopEMRJobFlowCmdlet.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.ES.AddESTagCmdlet"> <summary> Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging" target="_blank"> Tagging Amazon Elasticsearch Service Domains for more information.</a> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESTagCmdlet.ARN"> <summary> <para> <para> Specify the <code>ARN</code> for which you want to add the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESTagCmdlet.TagList"> <summary> <para> <para> List of <code>Tag</code> that need to be added for the Elasticsearch domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESTagCmdlet.PassThru"> <summary> Returns the value passed to the TagList parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.AddESTagCmdlet.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.ES.GetESDomainCmdlet"> <summary> Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainCmdlet.DomainName"> <summary> <para> <para>The name of the Elasticsearch domain for which you want information.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESDomainConfigCmdlet"> <summary> Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainConfigCmdlet.DomainName"> <summary> <para> <para>The Elasticsearch domain that you want to get information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESDomainListCmdlet"> <summary> Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESDomainListCmdlet.DomainName"> <summary> <para> <para>The Elasticsearch domains for which you want information.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESDomainNameListCmdlet"> <summary> Returns the name of all Elasticsearch domains owned by the current user's account. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.GetESTagCmdlet"> <summary> Returns all tags for the given Elasticsearch domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.GetESTagCmdlet.ARN"> <summary> <para> <para> Specify the <code>ARN</code> for the Elasticsearch domain to which the tags are attached that you want to view.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet"> <summary> Creates a new Elasticsearch domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains" target="_blank">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.AccessPolicy"> <summary> <para> <para> IAM access policy as a JSON-formatted string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.AdvancedOption"> <summary> <para> <para> Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration Advanced Options</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.SnapshotOptions_AutomatedSnapshotStartHour"> <summary> <para> <para>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_DedicatedMasterCount"> <summary> <para> <para>Total number of dedicated master nodes, active and on standby, for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_DedicatedMasterEnabled"> <summary> <para> <para>A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes" target="_blank">About Dedicated Master Nodes</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_DedicatedMasterType"> <summary> <para> <para>The instance type for a dedicated master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.DomainName"> <summary> <para> <para>The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EBSOptions_EBSEnabled"> <summary> <para> <para>Specifies whether EBS-based storage is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_InstanceCount"> <summary> <para> <para>The number of instances in the specified domain cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_InstanceType"> <summary> <para> <para>The instance type for an Elasticsearch cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EBSOptions_Iops"> <summary> <para> <para>Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EBSOptions_VolumeSize"> <summary> <para> <para> Integer to specify the size of an EBS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.EBSOptions_VolumeType"> <summary> <para> <para> Specifies the volume type for EBS-based storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.ElasticsearchClusterConfig_ZoneAwarenessEnabled"> <summary> <para> <para>A boolean value to indicate whether zone awareness is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness" target="_blank">About Zone Awareness</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.NewESDomainCmdlet.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.ES.RemoveESDomainCmdlet"> <summary> Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESDomainCmdlet.DomainName"> <summary> <para> <para>The name of the Elasticsearch domain that you want to permanently delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESDomainCmdlet.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.ES.RemoveESTagCmdlet"> <summary> Removes the specified set of tags from the specified Elasticsearch domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESTagCmdlet.ARN"> <summary> <para> <para>Specifies the <code>ARN</code> for the Elasticsearch domain from which you want to delete the specified tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESTagCmdlet.TagKey"> <summary> <para> <para>Specifies the <code>TagKey</code> list which you want to remove from the Elasticsearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESTagCmdlet.PassThru"> <summary> Returns the value passed to the TagKey parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.RemoveESTagCmdlet.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.ES.UpdateESDomainConfigCmdlet"> <summary> Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.AccessPolicy"> <summary> <para> <para>IAM access policy as a JSON-formatted string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.AdvancedOption"> <summary> <para> <para>Modifies the advanced option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration Advanced Options</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.SnapshotOptions_AutomatedSnapshotStartHour"> <summary> <para> <para>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_DedicatedMasterCount"> <summary> <para> <para>Total number of dedicated master nodes, active and on standby, for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_DedicatedMasterEnabled"> <summary> <para> <para>A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes" target="_blank">About Dedicated Master Nodes</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_DedicatedMasterType"> <summary> <para> <para>The instance type for a dedicated master node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.DomainName"> <summary> <para> <para>The name of the Elasticsearch domain that you are updating. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.EBSOptions_EBSEnabled"> <summary> <para> <para>Specifies whether EBS-based storage is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_InstanceCount"> <summary> <para> <para>The number of instances in the specified domain cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_InstanceType"> <summary> <para> <para>The instance type for an Elasticsearch cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.EBSOptions_Iops"> <summary> <para> <para>Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.EBSOptions_VolumeSize"> <summary> <para> <para> Integer to specify the size of an EBS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.EBSOptions_VolumeType"> <summary> <para> <para> Specifies the volume type for EBS-based storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.ElasticsearchClusterConfig_ZoneAwarenessEnabled"> <summary> <para> <para>A boolean value to indicate whether zone awareness is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness" target="_blank">About Zone Awareness</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ES.UpdateESDomainConfigCmdlet.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.ETS.GetETSJobsByPipelineCmdlet"> <summary> The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. <para> Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSJobsByPipelineCmdlet.Ascending"> <summary> <para> <para> To list jobs in chronological order by the date and time that they were submitted, enter <code>true</code>. To list jobs in reverse chronological order, enter <code>false</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSJobsByPipelineCmdlet.PipelineId"> <summary> <para> <para> The ID of the pipeline for which you want to get job information. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSJobsByPipelineCmdlet.PageToken"> <summary> <para> <para> When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ETS.GetETSJobsByStatusCmdlet"> <summary> The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSJobsByStatusCmdlet.Ascending"> <summary> <para> <para> To list jobs in chronological order by the date and time that they were submitted, enter <code>true</code>. To list jobs in reverse chronological order, enter <code>false</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSJobsByStatusCmdlet.Status"> <summary> <para> <para>To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or <code>Error</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSJobsByStatusCmdlet.PageToken"> <summary> <para> <para> When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ETS.GetETSPipelineCmdlet"> <summary> The ListPipelines operation gets a list of the pipelines associated with the current AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSPipelineCmdlet.Ascending"> <summary> <para> <para>To list pipelines in chronological order by the date and time that they were created, enter <code>true</code>. To list pipelines in reverse chronological order, enter <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSPipelineCmdlet.PageToken"> <summary> <para> <para>When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ETS.GetETSPresetCmdlet"> <summary> The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSPresetCmdlet.Ascending"> <summary> <para> <para>To list presets in chronological order by the date and time that they were created, enter <code>true</code>. To list presets in reverse chronological order, enter <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.GetETSPresetCmdlet.PageToken"> <summary> <para> <para>When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet"> <summary> When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. <para> If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.AlbumArt_Artwork"> <summary> <para> <para>The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are <code>.jpg</code> and <code>.png</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Input_AspectRatio"> <summary> <para> <para> The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify <code>auto</code>. If you want to specify the aspect ratio for the output file, enter one of the following values: </para><para><code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code></para><para> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of the aspect ratio. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Captions_CaptionFormat"> <summary> <para> <para>The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Captions_CaptionSource"> <summary> <para> <para>Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Output_Composition"> <summary> <para> <para>You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Input_Container"> <summary> <para> <para>The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify <code>auto</code>. If you want to specify the container type for the input file, enter one of the following values: </para><para><code>3gp</code>, <code>aac</code>, <code>asf</code>, <code>avi</code>, <code>divx</code>, <code>flv</code>, <code>m4a</code>, <code>mkv</code>, <code>mov</code>, <code>mp3</code>, <code>mp4</code>, <code>mpeg</code>, <code>mpeg-ps</code>, <code>mpeg-ts</code>, <code>mxf</code>, <code>ogg</code>, <code>vob</code>, <code>wav</code>, <code>webm</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.DetectedProperties_DurationMilli"> <summary> <para> <para>The detected duration of the input file, in milliseconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.DetectedProperties_FileSize"> <summary> <para> <para>The detected file size of the input file, in bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.DetectedProperties_FrameRate"> <summary> <para> <para>The detected frame rate of the input file, in frames per second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Input_FrameRate"> <summary> <para> <para>The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify <code>auto</code>. If you want to specify the frame rate for the input file, enter one of the following values: </para><para><code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code></para><para>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of the frame rate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.DetectedProperties_Height"> <summary> <para> <para>The detected height of the input file, in pixels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.InputEncryptionInitializationVector"> <summary> <para> <para>The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.OutputEncryptionInitializationVector"> <summary> <para> <para>The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.ThumbnailEncryption_InitializationVector"> <summary> <para> <para>The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Input_Interlaced"> <summary> <para> <para>Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify <code>auto</code>. If you want to specify whether the input file is interlaced, enter one of the following values:</para><para><code>true</code>, <code>false</code></para><para>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of interlacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.InputEncryptionKey"> <summary> <para> <para>The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:</para><para><code>128</code>, <code>192</code>, or <code>256</code>. </para><para>The key must also be encrypted by using the Amazon Key Management Service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Input_Key"> <summary> <para> <para> The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The <code>InputBucket</code> object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. </para><para>If the file name includes a prefix, such as <code>cooking/lasagna.mpg</code>, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.OutputEncryptionKey"> <summary> <para> <para>The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:</para><para><code>128</code>, <code>192</code>, or <code>256</code>. </para><para>The key must also be encrypted by using the Amazon Key Management Service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Output_Key"> <summary> <para> <para> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the <code>OutputBucket</code> object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.ThumbnailEncryption_Key"> <summary> <para> <para>The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:</para><para><code>128</code>, <code>192</code>, or <code>256</code>. </para><para>The key must also be encrypted by using the Amazon Key Management Service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.InputEncryptionKeyMd5"> <summary> <para> <para>The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.OutputEncryptionKeyMd5"> <summary> <para> <para>The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.ThumbnailEncryption_KeyMd5"> <summary> <para> <para>The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.AlbumArt_MergePolicy"> <summary> <para> <para>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</para><para><ul><li><code>Replace:</code> The specified album art will replace any existing album art.</li><li><code>Prepend:</code> The specified album art will be placed in front of any existing album art.</li><li><code>Append:</code> The specified album art will be placed after any existing album art.</li><li><code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the specified album art file.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Captions_MergePolicy"> <summary> <para> <para>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</para><ul><li><para><b>MergeOverride:</b> Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.</para></li><li><para><b>MergeRetain:</b> Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If <code>CaptionSources</code> is empty, Elastic Transcoder omits all sidecar captions from the output files.</para></li><li><para><b>Override:</b> Elastic Transcoder transcodes only the sidecar captions that you specify in <code>CaptionSources</code>.</para></li></ul><para><code>MergePolicy</code> cannot be null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.InputEncryptionMode"> <summary> <para> <para>The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:</para><ul><li><para><b>S3:</b> Amazon S3 creates and manages the keys used for encrypting your files.</para></li><li><para><b>S3-AWS-KMS:</b> Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify <code>S3-AWS-KMS</code> and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.</para></li><li><para><b>AES-CBC-PKCS7:</b> A padded cipher-block mode of operation originally used for HLS files.</para></li><li><para><b>AES-CTR:</b> AES Counter Mode.</para></li><li><para><b>AES-GCM:</b> AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with will fail the decryption process.</para></li></ul><para>For all three AES options, you must provide the following settings, which must be base64-encoded:</para><ul><li><para><b>Key</b></para></li><li><para><b>Key MD5</b></para></li><li><para><b>Initialization Vector</b></para></li></ul><important><para>For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.OutputEncryptionMode"> <summary> <para> <para>The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:</para><ul><li><para><b>S3:</b> Amazon S3 creates and manages the keys used for encrypting your files.</para></li><li><para><b>S3-AWS-KMS:</b> Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify <code>S3-AWS-KMS</code> and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.</para></li><li><para><b>AES-CBC-PKCS7:</b> A padded cipher-block mode of operation originally used for HLS files.</para></li><li><para><b>AES-CTR:</b> AES Counter Mode.</para></li><li><para><b>AES-GCM:</b> AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with will fail the decryption process.</para></li></ul><para>For all three AES options, you must provide the following settings, which must be base64-encoded:</para><ul><li><para><b>Key</b></para></li><li><para><b>Key MD5</b></para></li><li><para><b>Initialization Vector</b></para></li></ul><important><para>For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.ThumbnailEncryption_Mode"> <summary> <para> <para>The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:</para><ul><li><para><b>S3:</b> Amazon S3 creates and manages the keys used for encrypting your files.</para></li><li><para><b>S3-AWS-KMS:</b> Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify <code>S3-AWS-KMS</code> and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.</para></li><li><para><b>AES-CBC-PKCS7:</b> A padded cipher-block mode of operation originally used for HLS files.</para></li><li><para><b>AES-CTR:</b> AES Counter Mode.</para></li><li><para><b>AES-GCM:</b> AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with will fail the decryption process.</para></li></ul><para>For all three AES options, you must provide the following settings, which must be base64-encoded:</para><ul><li><para><b>Key</b></para></li><li><para><b>Key MD5</b></para></li><li><para><b>Initialization Vector</b></para></li></ul><important><para>For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.OutputKeyPrefix"> <summary> <para> <para>The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Output"> <summary> <para> <para> A section of the request body that provides information about the transcoded (target) files. We recommend that you use the <code>Outputs</code> syntax instead of the <code>Output</code> syntax. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.PipelineId"> <summary> <para> <para>The <code>Id</code> of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Playlist"> <summary> <para> <para>If you specify a preset in <code>PresetId</code> for which the value of <code>Container</code> is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.</para><para>The maximum number of master playlists in a job is 30.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Output_PresetId"> <summary> <para> <para> The <code>Id</code> of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Input_Resolution"> <summary> <para> <para>This value must be <code>auto</code>, which causes Elastic Transcoder to automatically detect the resolution of the input file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Output_Rotate"> <summary> <para> <para> The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: <code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>, <code>270</code>. The value <code>auto</code> generally works only if the file that you're transcoding contains rotation metadata. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Output_SegmentDuration"> <summary> <para> <para><important>(Outputs in Fragmented MP4 or MPEG-TS format only.</important>If you specify a preset in <code>PresetId</code> for which the value of <code>Container</code> is <code>fmp4</code> (Fragmented MP4) or <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the target maximum duration of each segment in seconds. For <code>HLSv3</code> format playlists, each media segment is stored in a separate <code>.ts</code> file. For <code>HLSv4</code> and <code>Smooth</code> playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the <code>SegmentDuration</code>, though individual segments might be shorter or longer.</para><para>The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of the last segment is the remainder of total length/SegmentDuration.</para><para>Elastic Transcoder creates an output-specific playlist for each output <code>HLS</code> output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the <code>OutputKeys</code> of the associated playlist.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Output_ThumbnailPattern"> <summary> <para> <para>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.</para><para>If you don't want Elastic Transcoder to create thumbnails, specify "".</para><para> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence: </para><ul><li><para><b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you must include <code>{count}</code> in the <code>ThumbnailPattern</code> object. Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence number (beginning with <b>00001</b>) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. </para><important>If you specify a literal value and/or <code>{resolution}</code> but you omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create the job.</important></li><li><para><b>Literal values (Optional)</b>: You can specify literal values anywhere in the <code>ThumbnailPattern</code> object. For example, you can include them as a file name prefix or as a delimiter between <code>{resolution}</code> and <code>{count}</code>. </para></li><li><para><b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the resolution in the file name, include <code>{resolution}</code> in the <code>ThumbnailPattern</code> object. </para></li></ul><para>When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the <code>PresetID</code> value of <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name extension.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.UserMetadata"> <summary> <para> <para>User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in <code>key/value</code> pairs, and you can add up to 10 <code>key/value</code> pairs per job. Elastic Transcoder does not guarantee that <code>key/value</code> pairs will be returned in the same order in which you specify them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.Output_Watermark"> <summary> <para> <para>Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.DetectedProperties_Width"> <summary> <para> <para>The detected width of the input file, in pixels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSJobCmdlet.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.ETS.NewETSPipelineCmdlet"> <summary> The CreatePipeline operation creates a pipeline with settings that you specify. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.AwsKmsKeyArn"> <summary> <para> <para>The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.</para><para>If you use either <code>S3</code> or <code>S3-AWS-KMS</code> as your <code>Encryption:Mode</code>, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an <code>Encryption:Mode</code> of <code>AES-PKCS7</code>, <code>AES-CTR</code>, or <code>AES-GCM</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.ContentConfig_Bucket"> <summary> <para> <para> The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true: <ul><li>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</li><li>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</li><li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li><li>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</li></ul> If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.ThumbnailConfig_Bucket"> <summary> <para> <para> The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true: <ul><li>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</li><li>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</li><li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li><li>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</li></ul> If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.Notifications_Completed"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.Notifications_Error"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.InputBucket"> <summary> <para> <para>The Amazon S3 bucket in which you saved the media files that you want to transcode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.Name"> <summary> <para> <para>The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.</para><para>Constraints: Maximum 40 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.OutputBucket"> <summary> <para> <para>The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)</para><para>Specify this value when all of the following are true: <ul><li>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</li><li>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</li><li>You do not want to specify the permissions that Elastic Transcoder grants to the files. <important>When Elastic Transcoder saves files in <code>OutputBucket</code>, it grants full control over the files only to the AWS account that owns the role that is specified by <code>Role</code>.</important></li><li>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</li></ul></para><para>If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit <code>OutputBucket</code> and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.ContentConfig_Permission"> <summary> <para> <para>Optional. The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</para><para>If you include <code>Permissions</code>, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by <code>Role</code>. If you want that user to have full control, you must explicitly grant full control to the user.</para><para> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by <code>Role</code>, and grants no other permissions to any other user or group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.ThumbnailConfig_Permission"> <summary> <para> <para>Optional. The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</para><para>If you include <code>Permissions</code>, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by <code>Role</code>. If you want that user to have full control, you must explicitly grant full control to the user.</para><para> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by <code>Role</code>, and grants no other permissions to any other user or group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.Notifications_Progressing"> <summary> <para> <para>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.Role"> <summary> <para> <para>The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.ContentConfig_StorageClass"> <summary> <para> <para> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.ThumbnailConfig_StorageClass"> <summary> <para> <para> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.Notifications_Warning"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPipelineCmdlet.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.ETS.NewETSPresetCmdlet"> <summary> The CreatePreset operation creates a preset with settings that you specify. <important>Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (<code>ValidationException</code>) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.</important><para> Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication <i>Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Thumbnails_AspectRatio"> <summary> <para> <important><para>To better control resolution and aspect ratio of thumbnails, we recommend that you use the values <code>MaxWidth</code>, <code>MaxHeight</code>, <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do not use them together.</para></important><para>The aspect ratio of thumbnails. Valid values include:</para><para><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code></para><para>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_AspectRatio"> <summary> <para> <important><para>To better control resolution and aspect ratio of output videos, we recommend that you use the values <code>MaxWidth</code>, <code>MaxHeight</code>, <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do not use them together.</para></important><para>The display aspect ratio of the video in the output file. Valid values include:</para><para><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code></para><para>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the input file.</para><para>If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Audio_AudioPackingMode"> <summary> <para> <para>The method of organizing audio channels and tracks. Use <code>Audio:Channels</code> to specify the number of channels in your output, and <code>Audio:AudioPackingMode</code> to specify the number of tracks and their relation to the channels. If you do not specify an <code>Audio:AudioPackingMode</code>, Elastic Transcoder uses <code>SingleTrack</code>.</para><para>The following values are valid:</para><para><code>SingleTrack</code>, <code>OneChannelPerTrack</code>, and <code>OneChannelPerTrackWithMosTo8Tracks</code></para><para>When you specify <code>SingleTrack</code>, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use <code>SingleTrack</code> for all non-<code>mxf</code> containers.</para><para>The outputs of <code>SingleTrack</code> for a specific channel value and inputs are as follows:</para><ul><li><code>0</code><b> channels with any input:</b> Audio omitted from the output</li><li><code>1, 2, or auto </code><b>channels with no audio input:</b> Audio omitted from the output</li><li><code>1 </code><b>channel with any input with audio:</b> One track with one channel, downmixed if necessary</li><li><code>2 </code><b>channels with one track with one channel:</b> One track with two identical channels</li><li><code>2 or auto </code><b>channels with two tracks with one channel each:</b> One track with two channels</li><li><code>2 or auto </code><b>channels with one track with two channels:</b> One track with two channels</li><li><code>2 </code><b>channels with one track with multiple channels:</b> One track with two channels</li><li><code>auto </code><b>channels with one track with one channel:</b> One track with one channel</li><li><code>auto </code><b>channels with one track with multiple channels:</b> One track with multiple channels</li></ul><para>When you specify <code>OneChannelPerTrack</code>, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.</para><para>The outputs of <code>OneChannelPerTrack</code> for a specific channel value and inputs are as follows:</para><ul><li><code>0 </code><b>channels with any input:</b> Audio omitted from the output</li><li><code>1, 2, or auto </code><b>channels with no audio input:</b> Audio omitted from the output</li><li><code>1 </code><b>channel with any input with audio:</b> One track with one channel, downmixed if necessary</li><li><code>2 </code><b>channels with one track with one channel:</b> Two tracks with one identical channel each</li><li><code>2 or auto </code><b>channels with two tracks with one channel each:</b> Two tracks with one channel each</li><li><code>2 or auto </code><b>channels with one track with two channels:</b> Two tracks with one channel each</li><li><code>2 </code><b>channels with one track with multiple channels:</b> Two tracks with one channel each</li><li><code>auto </code><b>channels with one track with one channel:</b> One track with one channel</li><li><code>auto </code><b>channels with one track with multiple channels:</b> Up to eight tracks with one channel each</li></ul><para>When you specify <code>OneChannelPerTrackWithMosTo8Tracks</code>, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.</para><para>The outputs of <code>OneChannelPerTrackWithMosTo8Tracks</code> for a specific channel value and inputs are as follows:</para><ul><li><code>0 </code><b>channels with any input:</b> Audio omitted from the output</li><li><code>1, 2, or auto </code><b>channels with no audio input:</b> Audio omitted from the output</li><li><code>1 </code><b>channel with any input with audio:</b> One track with one channel, downmixed if necessary, plus six MOS tracks</li><li><code>2 </code><b>channels with one track with one channel:</b> Two tracks with one identical channel each, plus six MOS tracks</li><li><code>2 or auto </code><b>channels with two tracks with one channel each:</b> Two tracks with one channel each, plus six MOS tracks</li><li><code>2 or auto </code><b>channels with one track with two channels:</b> Two tracks with one channel each, plus six MOS tracks</li><li><code>2 </code><b>channels with one track with multiple channels:</b> Two tracks with one channel each, plus six MOS tracks</li><li><code>auto </code><b>channels with one track with one channel:</b> One track with one channel, plus seven MOS tracks</li><li><code>auto </code><b>channels with one track with multiple channels:</b> Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.CodecOptions_BitDepth"> <summary> <para> <para>You can only choose an audio bit depth when you specify <code>flac</code> or <code>pcm</code> for the value of Audio:Codec.</para><para>The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file.</para><para>Valid values are <code>16</code> and <code>24</code>.</para><para>The most common bit depth is <code>24</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.CodecOptions_BitOrder"> <summary> <para> <para>You can only choose an audio bit order when you specify <code>pcm</code> for the value of Audio:Codec.</para><para>The order the bits of a PCM sample are stored in.</para><para>The supported value is <code>LittleEndian</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Audio_BitRate"> <summary> <para> <para>The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_BitRate"> <summary> <para> <para>The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of <code>Level</code> and <code>Profile</code>. If you specify <code>auto</code>, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than <code>auto</code>, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:</para><para><i>Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)</i></para><ul><li>1 - 64 : 80</li><li>1b - 128 : 160</li><li>1.1 - 192 : 240</li><li>1.2 - 384 : 480</li><li>1.3 - 768 : 960</li><li>2 - 2000 : 2500</li><li>3 - 10000 : 12500</li><li>3.1 - 14000 : 17500</li><li>3.2 - 20000 : 25000</li><li>4 - 20000 : 25000</li><li>4.1 - 50000 : 62500</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Audio_Channel"> <summary> <para> <para>The number of audio channels in the output file. The following values are valid:</para><para><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></para><para>One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select <code>auto</code>.</para><para>The output of a specific channel value and inputs are as follows:</para><ul><li><code>auto</code><b> channel specified, with any input:</b> Pass through up to eight input channels.</li><li><code>0</code><b> channels specified, with any input:</b> Audio omitted from the output.</li><li><code>1</code><b> channel specified, with at least one input channel:</b> Mono sound.</li><li><code>2</code><b> channels specified, with any input:</b> Two identical mono channels or stereo. For more information about tracks, see <code>Audio:AudioPackingMode.</code></li></ul><para> For more information about how Elastic Transcoder organizes channels and tracks, see <code>Audio:AudioPackingMode</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Audio_Codec"> <summary> <para> <para>The audio codec for the output file. Valid values include <code>aac</code>, <code>flac</code>, <code>mp2</code>, <code>mp3</code>, <code>pcm</code>, and <code>vorbis</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_Codec"> <summary> <para> <para>The video codec for the output file. Valid values include <code>gif</code>, <code>H.264</code>, <code>mpeg2</code>, and <code>vp8</code>. You can only specify <code>vp8</code> when the container type is <code>webm</code>, <code>gif</code> when the container type is <code>gif</code>, and <code>mpeg2</code> when the container type is <code>mpg</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_CodecOption"> <summary> <para> <para><b>Profile (H.264/VP8 Only)</b></para><para>The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:</para><ul><li><code>baseline</code>: The profile most commonly used for videoconferencing and for mobile applications.</li><li><code>main</code>: The profile used for standard-definition digital TV broadcasts.</li><li><code>high</code>: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.</li></ul><para><b>Level (H.264 Only)</b></para><para>The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:</para><para><code>1</code>, <code>1b</code>, <code>1.1</code>, <code>1.2</code>, <code>1.3</code>, <code>2</code>, <code>2.1</code>, <code>2.2</code>, <code>3</code>, <code>3.1</code>, <code>3.2</code>, <code>4</code>, <code>4.1</code></para><para><b>MaxReferenceFrames (H.264 Only)</b></para><para>Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:</para><para><code>Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)</code></para><para>where <i>Width in pixels</i> and <i>Height in pixels</i> represent either MaxWidth and MaxHeight, or Resolution. <i>Maximum decoded picture buffer in macroblocks</i> depends on the value of the <code>Level</code> object. See the list below. (A macroblock is a block of pixels measuring 16x16.) </para><ul><li>1 - 396</li><li>1b - 396</li><li>1.1 - 900</li><li>1.2 - 2376</li><li>1.3 - 2376</li><li>2 - 2376</li><li>2.1 - 4752</li><li>2.2 - 8100</li><li>3 - 8100</li><li>3.1 - 18000</li><li>3.2 - 20480</li><li>4 - 32768</li><li>4.1 - 32768</li></ul><para><b>MaxBitRate (Optional, H.264/MPEG2/VP8 only)</b></para><para>The maximum number of bits per second in a video buffer; the size of the buffer is specified by <code>BufferSize</code>. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video.</para><para><b>BufferSize (Optional, H.264/MPEG2/VP8 only)</b></para><para>The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify <code>MaxBitRate</code> and omit <code>BufferSize</code>, Elastic Transcoder sets <code>BufferSize</code> to 10 times the value of <code>MaxBitRate</code>.</para><para><b>InterlacedMode (Optional, H.264/MPEG2 Only)</b></para><para>The interlace mode for the output video.</para><para>Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.</para><para>Valid values include <code>Progressive</code> (no interlacing, top to bottom), <code>TopFirst</code> (top field first), <code>BottomFirst</code> (bottom field first), and <code>Auto</code>.</para><para>If <code>InterlaceMode</code> is not specified, Elastic Transcoder uses <code>Progressive</code> for the output. If <code>Auto</code> is specified, Elastic Transcoder interlaces the output.</para><para><b>ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)</b></para><para>The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used by the computer to store information about how to render color. <code>Bt.601</code> is the standard for standard definition video, while <code>Bt.709</code> is the standard for high definition video.</para><para>Valid values include <code>None</code>, <code>Bt709toBt601</code>, <code>Bt601toBt709</code>, and <code>Auto</code>.</para><para>If you chose <code>Auto</code> for <code>ColorSpaceConversionMode</code> and your output is interlaced, your frame rate is one of <code>23.97</code>, <code>24</code>, <code>25</code>, <code>29.97</code>, <code>50</code>, or <code>60</code>, your <code>SegmentDuration</code> is null, and you are using one of the resolution changes from the list below, Elastic Transcoder applies the following color space conversions:</para><ul><li><i>Standard to HD, 720x480 to 1920x1080</i> - Elastic Transcoder applies <code>Bt601ToBt709</code></li><li><i>Standard to HD, 720x576 to 1920x1080</i> - Elastic Transcoder applies <code>Bt601ToBt709</code></li><li><i>HD to Standard, 1920x1080 to 720x480</i> - Elastic Transcoder applies <code>Bt709ToBt601</code></li><li><i>HD to Standard, 1920x1080 to 720x576</i> - Elastic Transcoder applies <code>Bt709ToBt601</code></li></ul><note>Elastic Transcoder may change the behavior of the <code>ColorspaceConversionMode</code><code>Auto</code> mode in the future. All outputs in a playlist must use the same <code>ColorSpaceConversionMode</code>.</note><para>If you do not specify a <code>ColorSpaceConversionMode</code>, Elastic Transcoder does not change the color space of a file. If you are unsure what <code>ColorSpaceConversionMode</code> was applied to your output file, you can check the <code>AppliedColorSpaceConversion</code> parameter included in your job response. If your job does not have an <code>AppliedColorSpaceConversion</code> in its response, no <code>ColorSpaceConversionMode</code> was applied.</para><para><b>ChromaSubsampling</b></para><para>The sampling pattern for the chroma (color) channels of the output video. Valid values include <code>yuv420p</code> and <code>yuv422p</code>.</para><para><code>yuv420p</code> samples the chroma information of every other horizontal and every other vertical line, <code>yuv422p</code> samples the color information of every horizontal line and every other vertical line.</para><para><b>LoopCount (Gif Only)</b></para><para>The number of times you want the output gif to loop. Valid values include <code>Infinite</code> and integers between <code>0</code> and <code>100</code>, inclusive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Container"> <summary> <para> <para>The container type for the output file. Valid values include <code>flac</code>, <code>flv</code>, <code>fmp4</code>, <code>gif</code>, <code>mp3</code>, <code>mp4</code>, <code>mpg</code>, <code>mxf</code>, <code>oga</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Description"> <summary> <para> <para>A description of the preset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_DisplayAspectRatio"> <summary> <para> <para>The value that Elastic Transcoder adds to the metadata in the output file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_FixedGOP"> <summary> <para> <para>Applicable only when the value of Video:Codec is one of <code>H.264</code>, <code>MPEG2</code>, or <code>VP8</code>.</para><para>Whether to use a fixed value for <code>FixedGOP</code>. Valid values are <code>true</code> and <code>false</code>:</para><ul><li><code>true</code>: Elastic Transcoder uses the value of <code>KeyframesMaxDist</code> for the distance between key frames (the number of frames in a group of pictures, or GOP).</li><li><code>false</code>: The distance between key frames can vary.</li></ul><important><para><code>FixedGOP</code> must be set to <code>true</code> for <code>fmp4</code> containers.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Thumbnails_Format"> <summary> <para> <para>The format of thumbnails, if any. Valid values are <code>jpg</code> and <code>png</code>. </para><para>You specify whether you want Elastic Transcoder to create thumbnails when you create a job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_FrameRate"> <summary> <para> <para>The frames per second for the video stream in the output file. Valid values include:</para><para><code>auto</code>, <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code></para><para>If you specify <code>auto</code>, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:</para><para><code>Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)</code></para><para>where:</para><ul><li><i>width in pixels</i> and <i>height in pixels</i> represent the Resolution of the output video.</li><li><i>maximum recommended decoding speed in Luma samples/second</i> is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.</li></ul><para>The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (<i>Level - Decoding speed</i>):</para><ul><li>1 - 380160</li><li>1b - 380160</li><li>1.1 - 76800</li><li>1.2 - 1536000</li><li>1.3 - 3041280</li><li>2 - 3041280</li><li>2.1 - 5068800</li><li>2.2 - 5184000</li><li>3 - 10368000</li><li>3.1 - 27648000</li><li>3.2 - 55296000</li><li>4 - 62914560</li><li>4.1 - 62914560</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Thumbnails_Interval"> <summary> <para> <para>The approximate number of seconds between thumbnails. Specify an integer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_KeyframesMaxDist"> <summary> <para> <para>Applicable only when the value of Video:Codec is one of <code>H.264</code>, <code>MPEG2</code>, or <code>VP8</code>.</para><para>The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.</para><para>For <code>Smooth</code> outputs, the <code>FrameRate</code> must have a constant ratio to the <code>KeyframesMaxDist</code>. This allows <code>Smooth</code> playlists to switch between different quality levels while the file is being played.</para><para>For example, an input file can have a <code>FrameRate</code> of 30 with a <code>KeyframesMaxDist</code> of 90. The output file then needs to have a ratio of 1:3. Valid outputs would have <code>FrameRate</code> of 30, 25, and 10, and <code>KeyframesMaxDist</code> of 90, 75, and 30, respectively.</para><para>Alternately, this can be achieved by setting <code>FrameRate</code> to auto and having the same values for <code>MaxFrameRate</code> and <code>KeyframesMaxDist</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_MaxFrameRate"> <summary> <para> <para>If you specify <code>auto</code> for <code>FrameRate</code>, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include: <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Thumbnails_MaxHeight"> <summary> <para> <para>The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_MaxHeight"> <summary> <para> <para>The maximum height of the output video in pixels. If you specify <code>auto</code>, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Thumbnails_MaxWidth"> <summary> <para> <para>The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_MaxWidth"> <summary> <para> <para> The maximum width of the output video in pixels. If you specify <code>auto</code>, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Name"> <summary> <para> <para>The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Thumbnails_PaddingPolicy"> <summary> <para> <para>When you set <code>PaddingPolicy</code> to <code>Pad</code>, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_PaddingPolicy"> <summary> <para> <para>When you set <code>PaddingPolicy</code> to <code>Pad</code>, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.CodecOptions_Profile"> <summary> <para> <para>You can only choose an audio profile when you specify AAC for the value of Audio:Codec.</para><para>Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:</para><ul><li><code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select the profile based on the bit rate selected for the output file.</li><li><code>AAC-LC</code>: The most common AAC profile. Use for bit rates larger than 64 kbps.</li><li><code>HE-AAC</code>: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps.</li><li><code>HE-AACv2</code>: Not supported on some players and devices. Use for bit rates less than 48 kbps.</li></ul><para>All outputs in a <code>Smooth</code> playlist must have the same value for <code>Profile</code>.</para><note><para>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Thumbnails_Resolution"> <summary> <para> <important><para>To better control resolution and aspect ratio of thumbnails, we recommend that you use the values <code>MaxWidth</code>, <code>MaxHeight</code>, <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do not use them together.</para></important><para>The width and height of thumbnail files in pixels. Specify a value in the format <code><i>width</i></code> x <code><i>height</i></code> where both values are even integers. The values cannot exceed the width and height that you specified in the <code>Video:Resolution</code> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_Resolution"> <summary> <para> <important><para>To better control resolution and aspect ratio of output videos, we recommend that you use the values <code>MaxWidth</code>, <code>MaxHeight</code>, <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do not use them together.</para></important><para>The width and height of the video in the output file, in pixels. Valid values are <code>auto</code> and <i>width</i> x <i>height</i>:</para><ul><li><code>auto</code>: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules.</li><li><code><i>width</i> x <i>height</i></code>: The width and height of the output video in pixels.</li></ul><para>Note the following about specifying the width and height:</para><ul><li>The width must be an even integer between 128 and 4096, inclusive.</li><li>The height must be an even integer between 96 and 3072, inclusive.</li><li>If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.</li><li>If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.</li><li>We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (<i>List - Max width x height value</i>):</li><ul><li>1 - 25344</li><li>1b - 25344</li><li>1.1 - 101376</li><li>1.2 - 101376</li><li>1.3 - 101376</li><li>2 - 101376</li><li>2.1 - 202752</li><li>2.2 - 404720</li><li>3 - 404720</li><li>3.1 - 921600</li><li>3.2 - 1310720</li><li>4 - 2097152</li><li>4.1 - 2097152</li></ul></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Audio_SampleRate"> <summary> <para> <para>The sample rate of the audio stream in the output file, in Hertz. Valid values include:</para><para><code>auto</code>, <code>22050</code>, <code>32000</code>, <code>44100</code>, <code>48000</code>, <code>96000</code></para><para>If you specify <code>auto</code>, Elastic Transcoder automatically detects the sample rate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.CodecOptions_Signed"> <summary> <para> <para>You can only choose whether an audio sample is signed when you specify <code>pcm</code> for the value of Audio:Codec.</para><para>Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned).</para><para>The supported value is <code>Signed</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Thumbnails_SizingPolicy"> <summary> <para> <para>Specify one of the following values to control scaling of thumbnails:</para><para><ul><li><code>Fit</code>: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. </li><li><code>Fill</code>: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail <code>MaxWidth</code> or <code>MaxHeight</code> settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.</li><li><code>Stretch</code>: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.</li><li><code>Keep</code>: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> settings, Elastic Transcoder crops the thumbnails.</li><li><code>ShrinkToFit</code>: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.</li><li><code>ShrinkToFill</code>: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_SizingPolicy"> <summary> <para> <para>Specify one of the following values to control scaling of the output video:</para><para><ul><li><code>Fit</code>: Elastic Transcoder scales the output video so it matches the value that you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without exceeding the other value.</li><li><code>Fill</code>: Elastic Transcoder scales the output video so it matches the value that you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value.</li><li><code>Stretch</code>: Elastic Transcoder stretches the output video to match the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative proportions of the input video and the output video are different, the output video will be distorted.</li><li><code>Keep</code>: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>, Elastic Transcoder crops the output video.</li><li><code>ShrinkToFit</code>: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up.</li><li><code>ShrinkToFill</code>: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.Video_Watermark"> <summary> <para> <para>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.</para><para>Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.</para><para>When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.NewETSPresetCmdlet.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.ETS.ReadETSJobCmdlet"> <summary> The ReadJob operation returns detailed information about a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.ReadETSJobCmdlet.Id"> <summary> <para> <para>The identifier of the job for which you want to get detailed information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.ReadETSJobCmdlet.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.ETS.ReadETSPipelineCmdlet"> <summary> The ReadPipeline operation gets detailed information about a pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.ReadETSPipelineCmdlet.Id"> <summary> <para> <para>The identifier of the pipeline to read.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.ReadETSPipelineCmdlet.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.ETS.ReadETSPresetCmdlet"> <summary> The ReadPreset operation gets detailed information about a preset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.ReadETSPresetCmdlet.Id"> <summary> <para> <para>The identifier of the preset for which you want to get detailed information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.ReadETSPresetCmdlet.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.ETS.RemoveETSPipelineCmdlet"> <summary> The DeletePipeline operation removes a pipeline. <para> You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, <code>DeletePipeline</code> returns an error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.RemoveETSPipelineCmdlet.Id"> <summary> <para> <para>The identifier of the pipeline that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.RemoveETSPipelineCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.RemoveETSPipelineCmdlet.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.ETS.RemoveETSPresetCmdlet"> <summary> The DeletePreset operation removes a preset that you've added in an AWS region. <note><para> You can't delete the default presets that are included with Elastic Transcoder. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.RemoveETSPresetCmdlet.Id"> <summary> <para> <para>The identifier of the preset for which you want to get detailed information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.RemoveETSPresetCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.RemoveETSPresetCmdlet.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.ETS.StopETSJobCmdlet"> <summary> The CancelJob operation cancels an unfinished job. <note>You can only cancel a job that has a status of <code>Submitted</code>. To prevent a pipeline from starting to process a job while you're getting the job identifier, use <a>UpdatePipelineStatus</a> to temporarily pause the pipeline.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.StopETSJobCmdlet.Id"> <summary> <para> <para>The identifier of the job that you want to cancel. </para><para>To get a list of the jobs (including their <code>jobId</code>) that have a status of <code>Submitted</code>, use the <a>ListJobsByStatus</a> API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.StopETSJobCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.StopETSJobCmdlet.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.ETS.TestETSRoleCmdlet"> <summary> The TestRole operation tests the IAM role used to create the pipeline. <para> The <code>TestRole</code> action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.TestETSRoleCmdlet.InputBucket"> <summary> <para> <para>The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.TestETSRoleCmdlet.OutputBucket"> <summary> <para> <para>The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.TestETSRoleCmdlet.Role"> <summary> <para> <para>The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.TestETSRoleCmdlet.Topic"> <summary> <para> <para>The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet"> <summary> Use the <code>UpdatePipeline</code> operation to update settings for a pipeline. <important>When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. </important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.AwsKmsKeyArn"> <summary> <para> <para>The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.</para><para>If you use either <code>S3</code> or <code>S3-AWS-KMS</code> as your <code>Encryption:Mode</code>, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an <code>Encryption:Mode</code> of <code>AES-PKCS7</code>, <code>AES-CTR</code>, or <code>AES-GCM</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.ContentConfig_Bucket"> <summary> <para> <para> The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true: <ul><li>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</li><li>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</li><li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li><li>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</li></ul> If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.ThumbnailConfig_Bucket"> <summary> <para> <para> The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true: <ul><li>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</li><li>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</li><li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li><li>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</li></ul> If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.Notifications_Completed"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.Notifications_Error"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.Id"> <summary> <para> <para>The ID of the pipeline that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.InputBucket"> <summary> <para> <para>The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.Name"> <summary> <para> <para>The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.</para><para>Constraints: Maximum 40 characters</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.ContentConfig_Permission"> <summary> <para> <para>Optional. The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</para><para>If you include <code>Permissions</code>, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by <code>Role</code>. If you want that user to have full control, you must explicitly grant full control to the user.</para><para> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by <code>Role</code>, and grants no other permissions to any other user or group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.ThumbnailConfig_Permission"> <summary> <para> <para>Optional. The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</para><para>If you include <code>Permissions</code>, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by <code>Role</code>. If you want that user to have full control, you must explicitly grant full control to the user.</para><para> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by <code>Role</code>, and grants no other permissions to any other user or group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.Notifications_Progressing"> <summary> <para> <para>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.Role"> <summary> <para> <para>The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.ContentConfig_StorageClass"> <summary> <para> <para> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.ThumbnailConfig_StorageClass"> <summary> <para> <para> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.Notifications_Warning"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineCmdlet.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.ETS.UpdateETSPipelineNotificationsCmdlet"> <summary> With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. <para> When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineNotificationsCmdlet.Notifications_Completed"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineNotificationsCmdlet.Notifications_Error"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineNotificationsCmdlet.Id"> <summary> <para> <para> The identifier of the pipeline for which you want to change notification settings. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineNotificationsCmdlet.Notifications_Progressing"> <summary> <para> <para>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineNotificationsCmdlet.Notifications_Warning"> <summary> <para> <para>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineNotificationsCmdlet.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.ETS.UpdateETSPipelineStatusCmdlet"> <summary> The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. <para> Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a <a>CancelJob</a> request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineStatusCmdlet.Id"> <summary> <para> <para>The identifier of the pipeline to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineStatusCmdlet.Status"> <summary> <para> <para>The desired status of the pipeline:</para><ul><li><code>Active</code>: The pipeline is processing jobs.</li><li><code>Paused</code>: The pipeline is not currently processing jobs.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ETS.UpdateETSPipelineStatusCmdlet.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.IAM.GetIAMCredentialReportCmdlet"> <summary> Retrieves a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>Using IAM</i> guide. The report is contained in a System.IO.Memory stream in the output. To have the cmdlet output the report contents as a single string object, use the -Raw switch. To have the report output as an array of lines use the -AsTextArray switch. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMCredentialReportCmdlet.AsTextArray"> <summary> If set the cmdlet will process the the memory stream contained in the service response to the pipeline as a series of lines of text. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMCredentialReportCmdlet.Raw"> <summary> If set the cmdlet output will be a single string containing all of the lines in the report/ </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.AddIAMClientIDToOpenIDConnectProviderCmdlet"> <summary> Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect provider. <para> This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMClientIDToOpenIDConnectProviderCmdlet.ClientID"> <summary> <para> <para>The client ID (also known as audience) to add to the IAM OpenID Connect provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMClientIDToOpenIDConnectProviderCmdlet.OpenIDConnectProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to add the client ID to. You can get a list of OIDC provider ARNs by using the <a>ListOpenIDConnectProviders</a> action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMClientIDToOpenIDConnectProviderCmdlet.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.IAM.AddIAMRoleToInstanceProfileCmdlet"> <summary> Adds the specified role to the specified instance profile. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMRoleToInstanceProfileCmdlet.InstanceProfileName"> <summary> <para> <para>The name of the instance profile to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMRoleToInstanceProfileCmdlet.RoleName"> <summary> <para> <para>The name of the role to add.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMRoleToInstanceProfileCmdlet.PassThru"> <summary> Returns the value passed to the InstanceProfileName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMRoleToInstanceProfileCmdlet.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.IAM.AddIAMUserToGroupCmdlet"> <summary> Adds the specified user to the specified group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMUserToGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMUserToGroupCmdlet.UserName"> <summary> <para> <para>The name of the user to add.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMUserToGroupCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.AddIAMUserToGroupCmdlet.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.IAM.DisableIAMMFADeviceCmdlet"> <summary> Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled. <para> For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.DisableIAMMFADeviceCmdlet.SerialNumber"> <summary> <para> <para> The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.DisableIAMMFADeviceCmdlet.UserName"> <summary> <para> <para>The name of the user whose MFA device you want to deactivate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.DisableIAMMFADeviceCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.DisableIAMMFADeviceCmdlet.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.IAM.EditIAMPasswordCmdlet"> <summary> Changes the password of the IAM user who is calling this action. The root account password is not affected by this action. <para> To change the password for a different user, see <a>UpdateLoginProfile</a>. For more information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EditIAMPasswordCmdlet.NewPassword"> <summary> <para> <para>The new password. The new password must conform to the AWS account's password policy, if one exists.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EditIAMPasswordCmdlet.OldPassword"> <summary> <para> <para>The IAM user's current password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EditIAMPasswordCmdlet.PassThru"> <summary> Returns the value passed to the OldPassword parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EditIAMPasswordCmdlet.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.IAM.EnableIAMMFADeviceCmdlet"> <summary> Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EnableIAMMFADeviceCmdlet.AuthenticationCode1"> <summary> <para> <para>An authentication code emitted by the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EnableIAMMFADeviceCmdlet.AuthenticationCode2"> <summary> <para> <para>A subsequent authentication code emitted by the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EnableIAMMFADeviceCmdlet.SerialNumber"> <summary> <para> <para> The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EnableIAMMFADeviceCmdlet.UserName"> <summary> <para> <para>The name of the user for whom you want to enable the MFA device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EnableIAMMFADeviceCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.EnableIAMMFADeviceCmdlet.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.IAM.GetIAMAccessKeyCmdlet"> <summary> Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para><para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para><note>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccessKeyCmdlet.UserName"> <summary> <para> <para>The name of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccessKeyCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccessKeyCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccessKeyLastUsedCmdlet"> <summary> Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccessKeyLastUsedCmdlet.AccessKeyId"> <summary> <para> <para>The identifier of an access key.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountAliasCmdlet"> <summary> Lists the account aliases associated with the account. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountAliasCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountAliasCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountAuthorizationDetailsCmdlet"> <summary> Retrieves information about all IAM users, groups, roles, and policies in your account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account. <para> You can optionally filter the results using the <code>Filter</code> parameter. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountAuthorizationDetailsCmdlet.Filter"> <summary> <para> <para>A list of entity types (user, group, role, local managed policy, or AWS managed policy) for filtering the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountAuthorizationDetailsCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountAuthorizationDetailsCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountPasswordPolicyCmdlet"> <summary> Retrieves the password policy for the AWS account. For more information about using a password policy, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a>. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMAccountSummaryCmdlet"> <summary> Retrieves information about IAM entity usage and IAM quotas in the AWS account. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedGroupPoliciesCmdlet"> <summary> Lists all managed policies that are attached to the specified group. <para> A group can also have inline policies embedded with it. To list the inline policies for a group, use the <a>ListGroupPolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedGroupPoliciesCmdlet.GroupName"> <summary> <para> <para>The name (friendly name, not ARN) of the group to list attached policies for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedGroupPoliciesCmdlet.PathPrefix"> <summary> <para> <para>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedGroupPoliciesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedGroupPoliciesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedRolePoliciesCmdlet"> <summary> Lists all managed policies that are attached to the specified role. <para> A role can also have inline policies embedded with it. To list the inline policies for a role, use the <a>ListRolePolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedRolePoliciesCmdlet.PathPrefix"> <summary> <para> <para>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedRolePoliciesCmdlet.RoleName"> <summary> <para> <para>The name (friendly name, not ARN) of the role to list attached policies for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedRolePoliciesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedRolePoliciesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedUserPoliciesCmdlet"> <summary> Lists all managed policies that are attached to the specified user. <para> A user can also have inline policies embedded with it. To list the inline policies for a user, use the <a>ListUserPolicies</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedUserPoliciesCmdlet.PathPrefix"> <summary> <para> <para>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedUserPoliciesCmdlet.UserName"> <summary> <para> <para>The name (friendly name, not ARN) of the user to list attached policies for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedUserPoliciesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMAttachedUserPoliciesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMContextKeysForCustomPolicyCmdlet"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use <a>GetContextKeysForPrincipalPolicy</a>. <para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call <a>SimulateCustomPolicy</a>. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMContextKeysForCustomPolicyCmdlet.PolicyInputList"> <summary> <para> <para>A list of policies for which you want list of context keys used in <code>Condition</code> elements.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMContextKeysForPrincipalPolicyCmdlet"> <summary> Gets a list of all of the context keys referenced in <code>Condition</code> elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of. <para> You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use <a>GetContextKeysForCustomPolicy</a> instead. </para><para><b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead. </para><para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMContextKeysForPrincipalPolicyCmdlet.PolicyInputList"> <summary> <para> <para>A optional list of additional policies for which you want list of context keys used in <code>Condition</code> elements.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMContextKeysForPrincipalPolicyCmdlet.PolicySourceArn"> <summary> <para> <para>The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMEntitiesForPolicyCmdlet"> <summary> Lists all users, groups, and roles that the specified managed policy is attached to. <para> You can use the optional <code>EntityFilter</code> parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set <code>EntityFilter</code> to <code>Role</code>. </para><para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMEntitiesForPolicyCmdlet.EntityFilter"> <summary> <para> <para>The entity type to use for filtering the results. </para><para>For example, when <code>EntityFilter</code> is <code>Role</code>, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMEntitiesForPolicyCmdlet.PathPrefix"> <summary> <para> <para>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMEntitiesForPolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMEntitiesForPolicyCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMEntitiesForPolicyCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupCmdlet"> <summary> Returns a list of users that are in the specified group. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupForUserCmdlet"> <summary> Lists the groups the specified user belongs to. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupForUserCmdlet.UserName"> <summary> <para> <para>The name of the user to list groups for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupForUserCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupForUserCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupPoliciesCmdlet"> <summary> Lists the names of the inline policies that are embedded in the specified group. <para> A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use <a>ListAttachedGroupPolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified group, the action returns an empty list. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupPoliciesCmdlet.GroupName"> <summary> <para> <para>The name of the group to list policies for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupPoliciesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupPoliciesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupPolicyCmdlet"> <summary> Retrieves the specified inline policy document that is embedded in the specified group. <para> A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para><para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupPolicyCmdlet.GroupName"> <summary> <para> <para>The name of the group the policy is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy document to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupsCmdlet"> <summary> Lists the groups that have the specified path prefix. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupsCmdlet.PathPrefix"> <summary> <para> <para> The path prefix for filtering the results. For example, the prefix <code>/division_abc/subdivision_xyz/</code> gets all groups whose path starts with <code>/division_abc/subdivision_xyz/</code>. </para><para> This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupsCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMGroupsCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfileCmdlet"> <summary> Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. For more information about ARNs, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs">ARNs</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfileCmdlet.InstanceProfileName"> <summary> <para> <para>The name of the instance profile to get information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfileForRoleCmdlet"> <summary> Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfileForRoleCmdlet.RoleName"> <summary> <para> <para>The name of the role to list instance profiles for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfileForRoleCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfileForRoleCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfilesCmdlet"> <summary> Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfilesCmdlet.PathPrefix"> <summary> <para> <para> The path prefix for filtering the results. For example, the prefix <code>/application_abc/component_xyz/</code> gets all instance profiles whose path starts with <code>/application_abc/component_xyz/</code>. </para><para> This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfilesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMInstanceProfilesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMLoginProfileCmdlet"> <summary> Retrieves the user name and password-creation date for the specified user. If the user has not been assigned a password, the action returns a 404 (<code>NoSuchEntity</code>) error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMLoginProfileCmdlet.UserName"> <summary> <para> <para>The name of the user whose login profile you want to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMMFADeviceCmdlet"> <summary> Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMMFADeviceCmdlet.UserName"> <summary> <para> <para>The name of the user whose MFA devices you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMMFADeviceCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMMFADeviceCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMOpenIDConnectProviderCmdlet"> <summary> Returns information about the specified OpenID Connect provider. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMOpenIDConnectProviderCmdlet.OpenIDConnectProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to get information for. You can get a list of OIDC provider ARNs by using the <a>ListOpenIDConnectProviders</a> action.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMOpenIDConnectProvidersCmdlet"> <summary> Lists information about the OpenID Connect providers in the AWS account. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMPoliciesCmdlet"> <summary> Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies. <para> You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your AWS account, set <code>Scope</code> to <code>Local</code>. To list only AWS managed policies, set <code>Scope</code> to <code>AWS</code>. </para><para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para><para> For more information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPoliciesCmdlet.OnlyAttached"> <summary> <para> <para>A flag to filter the results to only the attached policies. </para><para>When <code>OnlyAttached</code> is <code>true</code>, the returned list contains only the policies that are attached to a user, group, or role. When <code>OnlyAttached</code> is <code>false</code>, or when the parameter is not included, all policies are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPoliciesCmdlet.PathPrefix"> <summary> <para> <para>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPoliciesCmdlet.Scope"> <summary> <para> <para>The scope to use for filtering the results. </para><para>To list only AWS managed policies, set <code>Scope</code> to <code>AWS</code>. To list only the customer managed policies in your AWS account, set <code>Scope</code> to <code>Local</code>. </para><para>This parameter is optional. If it is not included, or if it is set to <code>All</code>, all policies are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPoliciesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPoliciesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyCmdlet"> <summary> Retrieves information about the specified managed policy, including the policy's default version and the total number of users, groups, and roles that the policy is attached to. For a list of the specific users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. This API returns metadata about the policy. To retrieve the policy document for a specific version of the policy, use <a>GetPolicyVersion</a>. <para> This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </para><para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyVersionCmdlet"> <summary> Retrieves information about the specified version of the specified managed policy, including the policy document. <para> To list the available versions for a policy, use <a>ListPolicyVersions</a>. </para><para> This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </para><para> For more information about the types of policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyVersionCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyVersionCmdlet.VersionId"> <summary> <para> <para>Identifies the policy version to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyVersionsCmdlet"> <summary> Lists information about the versions of the specified managed policy, including the version that is set as the policy's default version. <para> For more information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyVersionsCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyVersionsCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMPolicyVersionsCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMRoleCmdlet"> <summary> Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs">ARNs</a>. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRoleCmdlet.RoleName"> <summary> <para> <para>The name of the role to get information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolePoliciesCmdlet"> <summary> Lists the names of the inline policies that are embedded in the specified role. <para> A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use <a>ListAttachedRolePolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified role, the action returns an empty list. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolePoliciesCmdlet.RoleName"> <summary> <para> <para>The name of the role to list policies for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolePoliciesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolePoliciesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolePolicyCmdlet"> <summary> Retrieves the specified inline policy document that is embedded with the specified role. <para> A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para><para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolePolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy document to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolePolicyCmdlet.RoleName"> <summary> <para> <para>The name of the role associated with the policy.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolesCmdlet"> <summary> Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolesCmdlet.PathPrefix"> <summary> <para> <para> The path prefix for filtering the results. For example, the prefix <code>/application_abc/component_xyz/</code> gets all roles whose path starts with <code>/application_abc/component_xyz/</code>. </para><para> This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMRolesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMSAMLProviderCmdlet"> <summary> Returns the SAML provider metadocument that was uploaded when the provider was created or updated. <note>This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSAMLProviderCmdlet.SAMLProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SAML provider to get information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMSAMLProvidersCmdlet"> <summary> Lists the SAML providers in the account. <note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMServerCertificateCmdlet"> <summary> Retrieves information about the specified server certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMServerCertificateCmdlet.ServerCertificateName"> <summary> <para> <para>The name of the server certificate you want to retrieve information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMServerCertificatesCmdlet"> <summary> Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMServerCertificatesCmdlet.PathPrefix"> <summary> <para> <para> The path prefix for filtering the results. For example: <code>/company/servercerts</code> would get all server certificates for which the path starts with <code>/company/servercerts</code>. </para><para> This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMServerCertificatesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMServerCertificatesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMSigningCertificateCmdlet"> <summary> Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list. <para> Although each user is limited to a small number of signing certificates, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para><para> If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSigningCertificateCmdlet.UserName"> <summary> <para> <para>The name of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSigningCertificateCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSigningCertificateCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMSSHPublicKeyCmdlet"> <summary> Retrieves the specified SSH public key, including metadata about the key. <para> The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSSHPublicKeyCmdlet.Encoding"> <summary> <para> <para>Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use <code>SSH</code>. To retrieve the public key in PEM format, use <code>PEM</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSSHPublicKeyCmdlet.SSHPublicKeyId"> <summary> <para> <para>The unique identifier for the SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSSHPublicKeyCmdlet.UserName"> <summary> <para> <para>The name of the IAM user associated with the SSH public key.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMSSHPublicKeyListCmdlet"> <summary> Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list. <para> The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para><para> Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSSHPublicKeyListCmdlet.UserName"> <summary> <para> <para>The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the AWS access key used to sign the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSSHPublicKeyListCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMSSHPublicKeyListCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserCmdlet"> <summary> Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserCmdlet.UserName"> <summary> <para> <para>The name of the user to get information about.</para><para>This parameter is optional. If it is not included, it defaults to the user making the request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserPoliciesCmdlet"> <summary> Lists the names of the inline policies embedded in the specified user. <para> A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use <a>ListAttachedUserPolicies</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified user, the action returns an empty list. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserPoliciesCmdlet.UserName"> <summary> <para> <para>The name of the user to list policies for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserPoliciesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserPoliciesCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserPolicyCmdlet"> <summary> Retrieves the specified inline policy document that is embedded in the specified user. <para> A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </para><para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy document to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUserPolicyCmdlet.UserName"> <summary> <para> <para>The name of the user who the policy is associated with.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMUsersCmdlet"> <summary> Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUsersCmdlet.PathPrefix"> <summary> <para> <para> The path prefix for filtering the results. For example: <code>/division_abc/subdivision_xyz/</code>, which would get all user names whose path starts with <code>/division_abc/subdivision_xyz/</code>. </para><para> This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUsersCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMUsersCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.GetIAMVirtualMFADeviceCmdlet"> <summary> Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMVirtualMFADeviceCmdlet.AssignmentStatus"> <summary> <para> <para> The status (unassigned or assigned) of the devices to list. If you do not specify an <code>AssignmentStatus</code>, the action defaults to <code>Any</code> which lists both assigned and unassigned virtual MFA devices. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMVirtualMFADeviceCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.GetIAMVirtualMFADeviceCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.NewIAMAccessKeyCmdlet"> <summary> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para><para> For information about limits on the number of keys you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para><important> To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. </important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMAccessKeyCmdlet.UserName"> <summary> <para> <para>The user name that the new key will belong to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMAccessKeyCmdlet.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.IAM.NewIAMAccountAliasCmdlet"> <summary> Creates an alias for your AWS account. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMAccountAliasCmdlet.AccountAlias"> <summary> <para> <para>The account alias to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMAccountAliasCmdlet.PassThru"> <summary> Returns the value passed to the AccountAlias parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMAccountAliasCmdlet.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.IAM.NewIAMGroupCmdlet"> <summary> Creates a new group. <para> For information about the number of groups you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group to create. Do not include the path in this value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMGroupCmdlet.Path"> <summary> <para> <para> The path to the group. For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM Identifiers</a> in the <i>Using IAM</i> guide. </para><para>This parameter is optional. If it is not included, it defaults to a slash (/).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMGroupCmdlet.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.IAM.NewIAMInstanceProfileCmdlet"> <summary> Creates a new instance profile. For information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. <para> For information about the number of instance profiles you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMInstanceProfileCmdlet.InstanceProfileName"> <summary> <para> <para>The name of the instance profile to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMInstanceProfileCmdlet.Path"> <summary> <para> <para> The path to the instance profile. For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM Identifiers</a> in the <i>Using IAM</i> guide. </para><para>This parameter is optional. If it is not included, it defaults to a slash (/).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMInstanceProfileCmdlet.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.IAM.NewIAMLoginProfileCmdlet"> <summary> Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>Using IAM</i> guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMLoginProfileCmdlet.Password"> <summary> <para> <para>The new password for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMLoginProfileCmdlet.PasswordResetRequired"> <summary> <para> <para> Specifies whether the user is required to set a new password on next sign-in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMLoginProfileCmdlet.UserName"> <summary> <para> <para>The name of the user to create a password for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMLoginProfileCmdlet.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.IAM.NewIAMOpenIDConnectProviderCmdlet"> <summary> Creates an IAM entity to describe an identity provider (IdP) that supports <a href="http://openid.net/connect/">OpenID Connect (OIDC)</a>. <para> The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider. </para><para> When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS. </para><note>Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the <a>CreateOpenIDConnectProvider</a> action to highly-privileged users. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMOpenIDConnectProviderCmdlet.ClientIDList"> <summary> <para> <para>A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the <code>client_id</code> parameter on OAuth requests.) </para><para>You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider. </para><para>There is no defined format for a client ID. The <code>CreateOpenIDConnectProviderRequest</code> action accepts client IDs up to 255 characters long. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMOpenIDConnectProviderCmdlet.ThumbprintList"> <summary> <para> <para>A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.</para><para>The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string. </para><para>You must provide at least one thumbprint when creating an IAM OIDC provider. For example, if the OIDC provider is <code>server.example.com</code> and the provider stores its keys at "https://keys.server.example.com/openid-connect", the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com. </para><para>For more information about obtaining the OIDC provider's thumbprint, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html">Obtaining the Thumbprint for an OpenID Connect Provider</a> in the <i>IAM User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMOpenIDConnectProviderCmdlet.Url"> <summary> <para> <para>The URL of the identity provider. The URL must begin with "https://" and should correspond to the <code>iss</code> claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a host name, like "https://server.example.org" or "https://example.com". </para><para>You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMOpenIDConnectProviderCmdlet.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.IAM.NewIAMPolicyCmdlet"> <summary> Creates a new managed policy for your AWS account. <para> This operation creates a policy version with a version identifier of <code>v1</code> and sets v1 as the policy's default version. For more information about policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para><para> For more information about managed policies in general, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyCmdlet.Description"> <summary> <para> <para>A friendly description of the policy. </para><para>Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." </para><para>The policy description is immutable. After a value is assigned, it cannot be changed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyCmdlet.Path"> <summary> <para> <para>The path for the policy. </para><para>For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM Identifiers</a> in the <i>IAM User Guide</i>. </para><para>This parameter is optional. If it is not included, it defaults to a slash (/). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyCmdlet.PolicyDocument"> <summary> <para> <para>The policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyCmdlet.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.IAM.NewIAMPolicyVersionCmdlet"> <summary> Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version. <para> Optionally, you can set the new version as the policy's default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to. </para><para> For more information about managed policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyVersionCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyVersionCmdlet.PolicyDocument"> <summary> <para> <para>The policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyVersionCmdlet.SetAsDefault"> <summary> <para> <para>Specifies whether to set this version as the policy's default version.</para><para>When this parameter is <code>true</code>, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.</para><para>For more information about managed policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMPolicyVersionCmdlet.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.IAM.NewIAMRoleCmdlet"> <summary> Creates a new role for your AWS account. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For information about limitations on role names and the number of roles you can create, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. <para> The policy in the following example grants permission to an EC2 instance to assume the role. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMRoleCmdlet.AssumeRolePolicyDocument"> <summary> <para> <para>The policy that grants an entity permission to assume the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMRoleCmdlet.Path"> <summary> <para> <para> The path to the role. For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM Identifiers</a> in the <i>Using IAM</i> guide. </para><para>This parameter is optional. If it is not included, it defaults to a slash (/).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMRoleCmdlet.RoleName"> <summary> <para> <para>The name of the role to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMRoleCmdlet.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.IAM.NewIAMSAMLProviderCmdlet"> <summary> Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0. <para> The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS. </para><para> When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </para><note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note><para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMSAMLProviderCmdlet.Name"> <summary> <para> <para>The name of the provider to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMSAMLProviderCmdlet.SAMLMetadataDocument"> <summary> <para> <para>An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </para><para>For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMSAMLProviderCmdlet.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.IAM.NewIAMUserCmdlet"> <summary> Creates a new user for your AWS account. <para> For information about limitations on the number of users you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMUserCmdlet.Path"> <summary> <para> <para> The path for the user name. For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM Identifiers</a> in the <i>Using IAM</i> guide. </para><para>This parameter is optional. If it is not included, it defaults to a slash (/).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMUserCmdlet.UserName"> <summary> <para> <para>The name of the user to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMUserCmdlet.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.IAM.NewIAMVirtualMFADeviceCmdlet"> <summary> Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. <para> For information about limits on the number of MFA devices you can create, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on Entities</a> in the <i>Using IAM</i> guide. </para><important>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures. </important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMVirtualMFADeviceCmdlet.Path"> <summary> <para> <para> The path for the virtual MFA device. For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM Identifiers</a> in the <i>Using IAM</i> guide. </para><para>This parameter is optional. If it is not included, it defaults to a slash (/).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMVirtualMFADeviceCmdlet.VirtualMFADeviceName"> <summary> <para> <para> The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.NewIAMVirtualMFADeviceCmdlet.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.IAM.PublishIAMServerCertificateCmdlet"> <summary> Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded. <para> For information about the number of server certificates you can upload, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para><note>Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling <code>UploadServerCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>IAM User Guide</i>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMServerCertificateCmdlet.CertificateBody"> <summary> <para> <para>The contents of the public key certificate in PEM-encoded format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMServerCertificateCmdlet.CertificateChain"> <summary> <para> <para>The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMServerCertificateCmdlet.Path"> <summary> <para> <para>The path for the server certificate. For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM Identifiers</a> in the <i>Using IAM</i> guide. </para><para>This parameter is optional. If it is not included, it defaults to a slash (/).</para><note> If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the <code>--path</code> option. The path must begin with <code>/cloudfront</code> and must include a trailing slash (for example, <code>/cloudfront/test/</code>). </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMServerCertificateCmdlet.PrivateKey"> <summary> <para> <para>The contents of the private key in PEM-encoded format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMServerCertificateCmdlet.ServerCertificateName"> <summary> <para> <para>The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMServerCertificateCmdlet.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.IAM.PublishIAMSigningCertificateCmdlet"> <summary> Uploads an X.509 signing certificate and associates it with the specified user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is <code>Active</code>. <para> If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para><note>Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling <code>UploadSigningCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i>guide. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMSigningCertificateCmdlet.CertificateBody"> <summary> <para> <para>The contents of the signing certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMSigningCertificateCmdlet.UserName"> <summary> <para> <para>The name of the user the signing certificate is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMSigningCertificateCmdlet.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.IAM.PublishIAMSSHPublicKeyCmdlet"> <summary> Uploads an SSH public key and associates it with the specified IAM user. <para> The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMSSHPublicKeyCmdlet.SSHPublicKeyBody"> <summary> <para> <para>The SSH public key. The public key must be encoded in ssh-rsa format or PEM format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMSSHPublicKeyCmdlet.UserName"> <summary> <para> <para>The name of the IAM user to associate the SSH public key with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.PublishIAMSSHPublicKeyCmdlet.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.IAM.RegisterIAMGroupPolicyCmdlet"> <summary> Attaches the specified managed policy to the specified group. <para> You use this API to attach a managed policy to a group. To embed an inline policy in a group, use <a>PutGroupPolicy</a>. </para><para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMGroupPolicyCmdlet.GroupName"> <summary> <para> <para>The name (friendly name, not ARN) of the group to attach the policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMGroupPolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMGroupPolicyCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMGroupPolicyCmdlet.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.IAM.RegisterIAMRolePolicyCmdlet"> <summary> Attaches the specified managed policy to the specified role. <para> When you attach a managed policy to a role, the managed policy is used as the role's access (permissions) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. </para><para> Use this API to attach a managed policy to a role. To embed an inline policy in a role, use <a>PutRolePolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMRolePolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMRolePolicyCmdlet.RoleName"> <summary> <para> <para>The name (friendly name, not ARN) of the role to attach the policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMRolePolicyCmdlet.PassThru"> <summary> Returns the value passed to the RoleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMRolePolicyCmdlet.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.IAM.RegisterIAMUserPolicyCmdlet"> <summary> Attaches the specified managed policy to the specified user. <para> You use this API to attach a managed policy to a user. To embed an inline policy in a user, use <a>PutUserPolicy</a>. </para><para> For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMUserPolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMUserPolicyCmdlet.UserName"> <summary> <para> <para>The name (friendly name, not ARN) of the user to attach the policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMUserPolicyCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RegisterIAMUserPolicyCmdlet.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.IAM.RemoveIAMAccessKeyCmdlet"> <summary> Deletes the access key associated with the specified user. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMAccessKeyCmdlet.AccessKeyId"> <summary> <para> <para>The access key ID for the access key ID and secret access key you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMAccessKeyCmdlet.UserName"> <summary> <para> <para>The name of the user whose key you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMAccessKeyCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMAccessKeyCmdlet.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.IAM.RemoveIAMAccountAliasCmdlet"> <summary> Deletes the specified AWS account alias. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMAccountAliasCmdlet.AccountAlias"> <summary> <para> <para>The name of the account alias to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMAccountAliasCmdlet.PassThru"> <summary> Returns the value passed to the AccountAlias parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMAccountAliasCmdlet.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.IAM.RemoveIAMAccountPasswordPolicyCmdlet"> <summary> Deletes the password policy for the AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMAccountPasswordPolicyCmdlet.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.IAM.RemoveIAMClientIDFromOpenIDConnectProviderCmdlet"> <summary> Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect provider. <para> This action is idempotent; it does not fail or return an error if you try to remove a client ID that was removed previously. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMClientIDFromOpenIDConnectProviderCmdlet.ClientID"> <summary> <para> <para>The client ID (also known as audience) to remove from the IAM OpenID Connect provider. For more information about client IDs, see <a>CreateOpenIDConnectProvider</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMClientIDFromOpenIDConnectProviderCmdlet.OpenIDConnectProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to remove the client ID from. You can get a list of OIDC provider ARNs by using the <a>ListOpenIDConnectProviders</a> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMClientIDFromOpenIDConnectProviderCmdlet.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.IAM.RemoveIAMGroupCmdlet"> <summary> Deletes the specified group. The group must not contain any users or have any attached policies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMGroupCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMGroupCmdlet.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.IAM.RemoveIAMGroupPolicyCmdlet"> <summary> Deletes the specified inline policy that is embedded in the specified group. <para> A group can also have managed policies attached to it. To detach a managed policy from a group, use <a>DetachGroupPolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMGroupPolicyCmdlet.GroupName"> <summary> <para> <para>The name (friendly name, not ARN) identifying the group that the policy is embedded in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMGroupPolicyCmdlet.PolicyName"> <summary> <para> <para>The name identifying the policy document to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMGroupPolicyCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMGroupPolicyCmdlet.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.IAM.RemoveIAMInstanceProfileCmdlet"> <summary> Deletes the specified instance profile. The instance profile must not have an associated role. <important> Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. </important><para> For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMInstanceProfileCmdlet.InstanceProfileName"> <summary> <para> <para>The name of the instance profile to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMInstanceProfileCmdlet.PassThru"> <summary> Returns the value passed to the InstanceProfileName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMInstanceProfileCmdlet.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.IAM.RemoveIAMLoginProfileCmdlet"> <summary> Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console. <important> Deleting a user's password does not prevent a user from accessing IAM through the command line interface or the API. To prevent all user access you must also either make the access key inactive or delete it. For more information about making keys inactive or deleting them, see <a>UpdateAccessKey</a> and <a>DeleteAccessKey</a>. </important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMLoginProfileCmdlet.UserName"> <summary> <para> <para>The name of the user whose password you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMLoginProfileCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMLoginProfileCmdlet.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.IAM.RemoveIAMOpenIDConnectProviderCmdlet"> <summary> Deletes an IAM OpenID Connect identity provider. <para> Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail. </para><para> This action is idempotent; it does not fail or return an error if you call the action for a provider that was already deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMOpenIDConnectProviderCmdlet.OpenIDConnectProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM OpenID Connect provider to delete. You can get a list of OpenID Connect provider ARNs by using the <a>ListOpenIDConnectProviders</a> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMOpenIDConnectProviderCmdlet.PassThru"> <summary> Returns the value passed to the OpenIDConnectProviderArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMOpenIDConnectProviderCmdlet.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.IAM.RemoveIAMPolicyCmdlet"> <summary> Deletes the specified managed policy. <para> Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy: <ol><li>Detach the policy from all users, groups, and roles that the policy is attached to, using the <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a> APIs. To list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>. </li><li>Delete all versions of the policy using <a>DeletePolicyVersion</a>. To list the policy's versions, use <a>ListPolicyVersions</a>. You cannot use <a>DeletePolicyVersion</a> to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process. </li><li>Delete the policy (this automatically deletes the policy's default version) using this API. </li></ol></para><para> For information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMPolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMPolicyCmdlet.PassThru"> <summary> Returns the value passed to the PolicyArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMPolicyCmdlet.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.IAM.RemoveIAMPolicyVersionCmdlet"> <summary> Deletes the specified version of the specified managed policy. <para> You cannot delete the default version of a policy using this API. To delete the default version of a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use <a>ListPolicyVersions</a>. </para><para> For information about versions for managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMPolicyVersionCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMPolicyVersionCmdlet.VersionId"> <summary> <para> <para>The policy version to delete.</para><para>For more information about managed policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMPolicyVersionCmdlet.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.IAM.RemoveIAMRoleCmdlet"> <summary> Deletes the specified role. The role must not have any policies attached. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <important>Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. </important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRoleCmdlet.RoleName"> <summary> <para> <para>The name of the role to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRoleCmdlet.PassThru"> <summary> Returns the value passed to the RoleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRoleCmdlet.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.IAM.RemoveIAMRoleFromInstanceProfileCmdlet"> <summary> Removes the specified role from the specified instance profile. <important> Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance will break any applications running on the instance. </important><para> For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. For more information about instance profiles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html">About Instance Profiles</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRoleFromInstanceProfileCmdlet.InstanceProfileName"> <summary> <para> <para>The name of the instance profile to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRoleFromInstanceProfileCmdlet.RoleName"> <summary> <para> <para>The name of the role to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRoleFromInstanceProfileCmdlet.PassThru"> <summary> Returns the value passed to the InstanceProfileName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRoleFromInstanceProfileCmdlet.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.IAM.RemoveIAMRolePolicyCmdlet"> <summary> Deletes the specified inline policy that is embedded in the specified role. <para> A role can also have managed policies attached to it. To detach a managed policy from a role, use <a>DetachRolePolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRolePolicyCmdlet.PolicyName"> <summary> <para> <para>The name identifying the policy document to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRolePolicyCmdlet.RoleName"> <summary> <para> <para>The name (friendly name, not ARN) identifying the role that the policy is embedded in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRolePolicyCmdlet.PassThru"> <summary> Returns the value passed to the RoleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMRolePolicyCmdlet.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.IAM.RemoveIAMSAMLProviderCmdlet"> <summary> Deletes a SAML provider. <para> Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail. </para><note> This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSAMLProviderCmdlet.SAMLProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SAML provider to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSAMLProviderCmdlet.PassThru"> <summary> Returns the value passed to the SAMLProviderArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSAMLProviderCmdlet.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.IAM.RemoveIAMServerCertificateCmdlet"> <summary> Deletes the specified server certificate. <important> If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API Reference</i>. </important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMServerCertificateCmdlet.ServerCertificateName"> <summary> <para> <para>The name of the server certificate you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMServerCertificateCmdlet.PassThru"> <summary> Returns the value passed to the ServerCertificateName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMServerCertificateCmdlet.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.IAM.RemoveIAMSigningCertificateCmdlet"> <summary> Deletes the specified signing certificate associated with the specified user. <para> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSigningCertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the signing certificate to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSigningCertificateCmdlet.UserName"> <summary> <para> <para>The name of the user the signing certificate belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSigningCertificateCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSigningCertificateCmdlet.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.IAM.RemoveIAMSSHPublicKeyCmdlet"> <summary> Deletes the specified SSH public key. <para> The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSSHPublicKeyCmdlet.SSHPublicKeyId"> <summary> <para> <para>The unique identifier for the SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSSHPublicKeyCmdlet.UserName"> <summary> <para> <para>The name of the IAM user associated with the SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSSHPublicKeyCmdlet.PassThru"> <summary> Returns the value passed to the SSHPublicKeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMSSHPublicKeyCmdlet.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.IAM.RemoveIAMUserCmdlet"> <summary> Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserCmdlet.UserName"> <summary> <para> <para>The name of the user to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserCmdlet.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.IAM.RemoveIAMUserFromGroupCmdlet"> <summary> Removes the specified user from the specified group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserFromGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserFromGroupCmdlet.UserName"> <summary> <para> <para>The name of the user to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserFromGroupCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserFromGroupCmdlet.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.IAM.RemoveIAMUserPolicyCmdlet"> <summary> Deletes the specified inline policy that is embedded in the specified user. <para> A user can also have managed policies attached to it. To detach a managed policy from a user, use <a>DetachUserPolicy</a>. For more information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserPolicyCmdlet.PolicyName"> <summary> <para> <para>The name identifying the policy document to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserPolicyCmdlet.UserName"> <summary> <para> <para>The name (friendly name, not ARN) identifying the user that the policy is embedded in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserPolicyCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMUserPolicyCmdlet.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.IAM.RemoveIAMVirtualMFADeviceCmdlet"> <summary> Deletes a virtual MFA device. <note> You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see <a>DeactivateMFADevice</a>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMVirtualMFADeviceCmdlet.SerialNumber"> <summary> <para> <para> The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMVirtualMFADeviceCmdlet.PassThru"> <summary> Returns the value passed to the SerialNumber parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RemoveIAMVirtualMFADeviceCmdlet.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.IAM.RequestIAMCredentialReportCmdlet"> <summary> Generates a credential report for the AWS account. For more information about the credential report, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.RequestIAMCredentialReportCmdlet.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.IAM.SetIAMDefaultPolicyVersionCmdlet"> <summary> Sets the specified version of the specified policy as the policy's default (operative) version. <para> This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. </para><para> For information about managed policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SetIAMDefaultPolicyVersionCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SetIAMDefaultPolicyVersionCmdlet.VersionId"> <summary> <para> <para>The version of the policy to set as the default (operative) version.</para><para>For more information about managed policy versions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SetIAMDefaultPolicyVersionCmdlet.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.IAM.SyncIAMMFADeviceCmdlet"> <summary> Synchronizes the specified MFA device with AWS servers. <para> For more information about creating and working with virtual MFA devices, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SyncIAMMFADeviceCmdlet.AuthenticationCode1"> <summary> <para> <para>An authentication code emitted by the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SyncIAMMFADeviceCmdlet.AuthenticationCode2"> <summary> <para> <para>A subsequent authentication code emitted by the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SyncIAMMFADeviceCmdlet.SerialNumber"> <summary> <para> <para>Serial number that uniquely identifies the MFA device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SyncIAMMFADeviceCmdlet.UserName"> <summary> <para> <para>The name of the user whose MFA device you want to resynchronize.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SyncIAMMFADeviceCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.SyncIAMMFADeviceCmdlet.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.IAM.TestIAMCustomPolicyCmdlet"> <summary> Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings. <para> The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions. </para><para> If you want to simulate existing policies attached to an IAM user, group, or role, use <a>SimulatePrincipalPolicy</a> instead. </para><para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the <code>Condition</code> element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForCustomPolicy</a>. </para><para> If the output is long, you can use <code>MaxItems</code> and <code>Marker</code> parameters to paginate the results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.ActionName"> <summary> <para> <para>A list of names of API actions to evaluate in the simulation. Each action is evaluated against each resource. Each action must include the service identifier, such as <code>iam:CreateUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.CallerArn"> <summary> <para> <para>The ARN of the user that you want to use as the simulated caller of the APIs. <code>CallerArn</code> is required if you include a <code>ResourcePolicy</code> so that the policy's <code>Principal</code> element has a value to use in evaluating the policy.</para><para>You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.ContextEntry"> <summary> <para> <para>A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated by a <code>Condition</code> element in one of the simulated IAM permission policies, the corresponding value is supplied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.PolicyInputList"> <summary> <para> <para>A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the <code>ResourcePolicy</code> parameter. The policies cannot be "scope-down" policies, such as you could include in a call to <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_GetFederationToken.html">GetFederationToken</a> or one of the <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html">AssumeRole</a> APIs to restrict what a user can do while using the temporary credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.ResourceArn"> <summary> <para> <para>A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to <code>*</code> (all resources). Each API in the <code>ActionNames</code> parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.</para><para>The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the <code>ResourcePolicy</code> parameter.</para><para>If you include a <code>ResourcePolicy</code>, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.ResourceOwner"> <summary> <para> <para>An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If <code>ResourceOwner</code> is specified, it is also used as the account owner of any <code>ResourcePolicy</code> included in the simulation. If the <code>ResourceOwner</code> parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in <code>CallerArn</code>. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user <code>CallerArn</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.ResourcePolicy"> <summary> <para> <para>A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMCustomPolicyCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet"> <summary> Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to . <para> You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use <a>SimulateCustomPolicy</a> instead. </para><para> You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation. </para><para> The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions. </para><para><b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>SimulateCustomPolicy</a> instead. </para><para> Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the <code>Condition</code> element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForPrincipalPolicy</a>. </para><para> If the output is long, you can use the <code>MaxItems</code> and <code>Marker</code> parameters to paginate the results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.ActionName"> <summary> <para> <para>A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as <code>iam:CreateUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.CallerArn"> <summary> <para> <para>The ARN of the user that you want to specify as the simulated caller of the APIs. If you do not specify a <code>CallerArn</code>, it defaults to the ARN of the user that you specify in <code>PolicySourceArn</code>, if you specified a user. If you include both a <code>PolicySourceArn</code> (for example, <code>arn:aws:iam::123456789012:user/David</code>) and a <code>CallerArn</code> (for example, <code>arn:aws:iam::123456789012:user/Bob</code>), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.</para><para>You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.</para><para><code>CallerArn</code> is required if you include a <code>ResourcePolicy</code> and the <code>PolicySourceArn</code> is not the ARN for an IAM user. This is required so that the resource-based policy's <code>Principal</code> element has a value to use in evaluating the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.ContextEntry"> <summary> <para> <para>A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated by a <code>Condition</code> element in one of the simulated policies, the corresponding value is supplied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.PolicyInputList"> <summary> <para> <para>An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.PolicySourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.ResourceArn"> <summary> <para> <para>A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to <code>*</code> (all resources). Each API in the <code>ActionNames</code> parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.</para><para>The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the <code>ResourcePolicy</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.ResourceOwner"> <summary> <para> <para>An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If <code>ResourceOwner</code> is specified, it is also used as the account owner of any <code>ResourcePolicy</code> included in the simulation. If the <code>ResourceOwner</code> parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in <code>CallerArn</code>. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user <code>CallerArn</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.ResourcePolicy"> <summary> <para> <para>A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.TestIAMPrincipalPolicyCmdlet.MaxItem"> <summary> <para> <para>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</para><para>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMGroupPolicyCmdlet"> <summary> Removes the specified managed policy from the specified group. <para> A group can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteGroupPolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMGroupPolicyCmdlet.GroupName"> <summary> <para> <para>The name (friendly name, not ARN) of the group to detach the policy from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMGroupPolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMGroupPolicyCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMGroupPolicyCmdlet.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.IAM.UnregisterIAMRolePolicyCmdlet"> <summary> Removes the specified managed policy from the specified role. <para> A role can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteRolePolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMRolePolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMRolePolicyCmdlet.RoleName"> <summary> <para> <para>The name (friendly name, not ARN) of the role to detach the policy from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMRolePolicyCmdlet.PassThru"> <summary> Returns the value passed to the RoleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMRolePolicyCmdlet.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.IAM.UnregisterIAMUserPolicyCmdlet"> <summary> Removes the specified managed policy from the specified user. <para> A user can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteUserPolicy</a> API. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMUserPolicyCmdlet.PolicyArn"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMUserPolicyCmdlet.UserName"> <summary> <para> <para>The name (friendly name, not ARN) of the user to detach the policy from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMUserPolicyCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UnregisterIAMUserPolicyCmdlet.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.IAM.UpdateIAMAccessKeyCmdlet"> <summary> Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow. <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para><para> For information about rotating keys, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html">Managing Keys and Certificates</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccessKeyCmdlet.AccessKeyId"> <summary> <para> <para>The access key ID of the secret access key you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccessKeyCmdlet.Status"> <summary> <para> <para> The status you want to assign to the secret access key. <code>Active</code> means the key can be used for API calls to AWS, while <code>Inactive</code> means the key cannot be used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccessKeyCmdlet.UserName"> <summary> <para> <para>The name of the user whose key you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccessKeyCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccessKeyCmdlet.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.IAM.UpdateIAMAccountPasswordPolicyCmdlet"> <summary> Updates the password policy settings for the AWS account. <note><para> This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. </para></note><para> For more information about using a password policy, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html">Managing an IAM Password Policy</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.AllowUsersToChangePassword"> <summary> <para> <para> Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html">Letting IAM Users Change Their Own Passwords</a> in the <i>IAM User Guide</i>. </para><para>Default value: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.HardExpiry"> <summary> <para> <para>Prevents IAM users from setting a new password after their password has expired.</para><para>Default value: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.MaxPasswordAge"> <summary> <para> <para>The number of days that an IAM user password is valid. The default value of 0 means IAM user passwords never expire.</para><para>Default value: 0</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.MinimumPasswordLength"> <summary> <para> <para>The minimum number of characters allowed in an IAM user password.</para><para>Default value: 6</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.PasswordReusePrevention"> <summary> <para> <para>Specifies the number of previous passwords that IAM users are prevented from reusing. The default value of 0 means IAM users are not prevented from reusing previous passwords.</para><para>Default value: 0</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.RequireLowercaseCharacter"> <summary> <para> <para>Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).</para><para>Default value: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.RequireNumber"> <summary> <para> <para>Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).</para><para>Default value: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.RequireSymbol"> <summary> <para> <para>Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:</para><para>! @ # $ % ^ &amp; * ( ) _ + - = [ ] { } | '</para><para>Default value: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.RequireUppercaseCharacter"> <summary> <para> <para>Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).</para><para>Default value: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAccountPasswordPolicyCmdlet.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.IAM.UpdateIAMAssumeRolePolicyCmdlet"> <summary> Updates the policy that grants an entity permission to assume a role. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAssumeRolePolicyCmdlet.PolicyDocument"> <summary> <para> <para>The policy that grants an entity permission to assume the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAssumeRolePolicyCmdlet.RoleName"> <summary> <para> <para>The name of the role to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAssumeRolePolicyCmdlet.PassThru"> <summary> Returns the value passed to the RoleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMAssumeRolePolicyCmdlet.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.IAM.UpdateIAMGroupCmdlet"> <summary> Updates the name and/or the path of the specified group. <important> You should understand the implications of changing a group's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming Users and Groups</a> in the <i>IAM User Guide</i>. </important><note>To change a group name the requester must have appropriate permissions on both the source object and the target object. For example, to change Managers to MGRs, the entity making the request must have permission on Managers and MGRs, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMGroupCmdlet.GroupName"> <summary> <para> <para> Name of the group to update. If you're changing the name of the group, this is the original name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMGroupCmdlet.NewGroupName"> <summary> <para> <para>New name for the group. Only include this if changing the group's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMGroupCmdlet.NewPath"> <summary> <para> <para>New path for the group. Only include this if changing the group's path.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMGroupCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMGroupCmdlet.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.IAM.UpdateIAMLoginProfileCmdlet"> <summary> Changes the password for the specified user. <para> Users can change their own passwords by calling <a>ChangePassword</a>. For more information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html">Managing Passwords</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMLoginProfileCmdlet.Password"> <summary> <para> <para>The new password for the specified user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMLoginProfileCmdlet.PasswordResetRequired"> <summary> <para> <para>Require the specified user to set a new password on next sign-in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMLoginProfileCmdlet.UserName"> <summary> <para> <para>The name of the user whose password you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMLoginProfileCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMLoginProfileCmdlet.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.IAM.UpdateIAMOpenIDConnectProviderThumbprintCmdlet"> <summary> Replaces the existing list of server certificate thumbprints with a new list. <para> The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.) </para><para> Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate <i>does</i> change, any attempt to assume an IAM role that specifies the OIDC provider as a principal will fail until the certificate thumbprint is updated. </para><note>Because trust for the OpenID Connect provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the <code>UpdateOpenIDConnectProviderThumbprint</code> action to highly-privileged users. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMOpenIDConnectProviderThumbprintCmdlet.OpenIDConnectProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to update the thumbprint for. You can get a list of OIDC provider ARNs by using the <a>ListOpenIDConnectProviders</a> action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMOpenIDConnectProviderThumbprintCmdlet.ThumbprintList"> <summary> <para> <para>A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see <a>CreateOpenIDConnectProvider</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMOpenIDConnectProviderThumbprintCmdlet.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.IAM.UpdateIAMSAMLProviderCmdlet"> <summary> Updates the metadata document for an existing SAML provider. <note>This operation requires <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSAMLProviderCmdlet.SAMLMetadataDocument"> <summary> <para> <para> An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSAMLProviderCmdlet.SAMLProviderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SAML provider to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSAMLProviderCmdlet.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.IAM.UpdateIAMServerCertificateCmdlet"> <summary> Updates the name and/or the path of the specified server certificate. <important> You should understand the implications of changing a server certificate's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html">Managing Server Certificates</a> in the <i>IAM User Guide</i>. </important><note>To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from ProductionCert to ProdCert, the entity making the request must have permission on ProductionCert and ProdCert, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMServerCertificateCmdlet.NewPath"> <summary> <para> <para> The new path for the server certificate. Include this only if you are updating the server certificate's path. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMServerCertificateCmdlet.NewServerCertificateName"> <summary> <para> <para> The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMServerCertificateCmdlet.ServerCertificateName"> <summary> <para> <para>The name of the server certificate that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMServerCertificateCmdlet.PassThru"> <summary> Returns the value passed to the ServerCertificateName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMServerCertificateCmdlet.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.IAM.UpdateIAMSigningCertificateCmdlet"> <summary> Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow. <para> If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSigningCertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the signing certificate you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSigningCertificateCmdlet.Status"> <summary> <para> <para> The status you want to assign to the certificate. <code>Active</code> means the certificate can be used for API calls to AWS, while <code>Inactive</code> means the certificate cannot be used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSigningCertificateCmdlet.UserName"> <summary> <para> <para>The name of the user the signing certificate belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSigningCertificateCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSigningCertificateCmdlet.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.IAM.UpdateIAMSSHPublicKeyCmdlet"> <summary> Sets the status of the specified SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow. <para> The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href="http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSSHPublicKeyCmdlet.SSHPublicKeyId"> <summary> <para> <para>The unique identifier for the SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSSHPublicKeyCmdlet.Status"> <summary> <para> <para>The status to assign to the SSH public key. <code>Active</code> means the key can be used for authentication with an AWS CodeCommit repository. <code>Inactive</code> means the key cannot be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSSHPublicKeyCmdlet.UserName"> <summary> <para> <para>The name of the IAM user associated with the SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSSHPublicKeyCmdlet.PassThru"> <summary> Returns the value passed to the SSHPublicKeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMSSHPublicKeyCmdlet.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.IAM.UpdateIAMUserCmdlet"> <summary> Updates the name and/or the path of the specified user. <important> You should understand the implications of changing a user's path or name. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html">Renaming Users and Groups</a> in the <i>IAM User Guide</i>. </important><note> To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMUserCmdlet.NewPath"> <summary> <para> <para>New path for the user. Include this parameter only if you're changing the user's path.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMUserCmdlet.NewUserName"> <summary> <para> <para>New name for the user. Include this parameter only if you're changing the user's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMUserCmdlet.UserName"> <summary> <para> <para>Name of the user to update. If you're changing the name of the user, this is the original user name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMUserCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.UpdateIAMUserCmdlet.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.IAM.WriteIAMGroupPolicyCmdlet"> <summary> Adds (or updates) an inline policy document that is embedded in the specified group. <para> A user can also have managed policies attached to it. To attach a managed policy to a group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> For information about limits on the number of inline policies that you can embed in a group, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para><note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMGroupPolicyCmdlet.GroupName"> <summary> <para> <para>The name of the group to associate the policy with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMGroupPolicyCmdlet.PolicyDocument"> <summary> <para> <para>The policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMGroupPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMGroupPolicyCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMGroupPolicyCmdlet.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.IAM.WriteIAMRolePolicyCmdlet"> <summary> Adds (or updates) an inline policy document that is embedded in the specified role. <para> When you embed an inline policy in a role, the inline policy is used as the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">Using Roles to Delegate Permissions and Federate Identities</a>. </para><para> A role can also have a managed policy attached to it. To attach a managed policy to a role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> For information about limits on the number of inline policies that you can embed with a role, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para><note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMRolePolicyCmdlet.PolicyDocument"> <summary> <para> <para>The policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMRolePolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMRolePolicyCmdlet.RoleName"> <summary> <para> <para>The name of the role to associate the policy with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMRolePolicyCmdlet.PassThru"> <summary> Returns the value passed to the RoleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMRolePolicyCmdlet.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.IAM.WriteIAMUserPolicyCmdlet"> <summary> Adds (or updates) an inline policy document that is embedded in the specified user. <para> A user can also have a managed policy attached to it. To attach a managed policy to a user, use <a>AttachUserPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </para><para> For information about limits on the number of inline policies that you can embed in a user, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </para><note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</code>. For general information about using the Query API with IAM, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in the <i>Using IAM</i> guide. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMUserPolicyCmdlet.PolicyDocument"> <summary> <para> <para>The policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMUserPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMUserPolicyCmdlet.UserName"> <summary> <para> <para>The name of the user to associate the policy with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMUserPolicyCmdlet.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IAM.WriteIAMUserPolicyCmdlet.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.IE.GetIEJobCmdlet"> <summary> This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEJobCmdlet.APIVersion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEJobCmdlet.MaxJob"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEJobCmdlet.Marker"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet"> <summary> This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.APIVersion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.City"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.Company"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.Country"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.JobId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.Name"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.PhoneNumber"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.PostalCode"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.StateOrProvince"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.Street1"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.Street2"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEShippingLabelCmdlet.Street3"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IE.GetIEStatusCmdlet"> <summary> This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEStatusCmdlet.APIVersion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.GetIEStatusCmdlet.JobId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IE.NewIEJobCmdlet"> <summary> This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.NewIEJobCmdlet.APIVersion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.NewIEJobCmdlet.JobType"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.NewIEJobCmdlet.Manifest"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.NewIEJobCmdlet.ManifestAddendum"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.NewIEJobCmdlet.ValidateOnly"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.NewIEJobCmdlet.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.IE.StopIEJobCmdlet"> <summary> This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.StopIEJobCmdlet.APIVersion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.StopIEJobCmdlet.JobId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.StopIEJobCmdlet.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.IE.UpdateIEJobCmdlet"> <summary> You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.UpdateIEJobCmdlet.APIVersion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.UpdateIEJobCmdlet.JobId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.UpdateIEJobCmdlet.JobType"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.UpdateIEJobCmdlet.Manifest"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.UpdateIEJobCmdlet.ValidateOnly"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IE.UpdateIEJobCmdlet.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.INS.AddINSAssessmentRulesPackageCmdlet"> <summary> Attaches the rules package specified by the rules package ARN to the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.AddINSAssessmentRulesPackageCmdlet.AssessmentArn"> <summary> <para> <para>The ARN specifying the assessment to which you want to attach a rules package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.AddINSAssessmentRulesPackageCmdlet.RulesPackageArn"> <summary> <para> <para>The ARN specifying the rules package that you want to attach to the assessment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.AddINSAssessmentRulesPackageCmdlet.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.INS.AddINSFindingAttributeCmdlet"> <summary> Assigns attributes (key and value pair) to the findings specified by the findings' ARNs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.AddINSFindingAttributeCmdlet.Attribute"> <summary> <para> <para>The array of attributes that you want to assign to specified findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.AddINSFindingAttributeCmdlet.FindingArn"> <summary> <para> <para>The ARNs specifying the findings that you want to assign attributes to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.AddINSFindingAttributeCmdlet.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.INS.GetINSApplicationCmdlet"> <summary> Describes the application specified by the application ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSApplicationCmdlet.ApplicationArn"> <summary> <para> <para>The ARN specifying the application that you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSApplicationListCmdlet"> <summary> Lists the ARNs of the applications within this AWS account. For more information about applications, see <a href="https://docs.aws.amazon.com/inspector/latest/userguide//inspector_applications.html">Inspector Applications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSApplicationListCmdlet.Filter_ApplicationNamePattern"> <summary> <para> <para>For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the <b>applicationName</b> property of the <a>Application</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSApplicationListCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSApplicationListCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>ListApplications</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentCmdlet"> <summary> Describes the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentCmdlet.AssessmentArn"> <summary> <para> <para>The ARN specifying the assessment that you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentAgentListCmdlet"> <summary> Lists the agents of the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentAgentListCmdlet.Filter_AgentHealthList"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>agentHealth</b> property of the <a>Agent</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentAgentListCmdlet.AssessmentArn"> <summary> <para> <para>The ARN specifying the assessment whose agents you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentAgentListCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentAgentListCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>ListAssessmentAgents</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet"> <summary> Lists the assessments corresponding to applications specified by the applications' ARNs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.ApplicationArn"> <summary> <para> <para>A list of ARNs specifying the applications the assessments of which you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.Filter_AssessmentNamePattern"> <summary> <para> <para>For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the <b>assessmentName</b> property of the <a>Assessment</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.Filter_AssessmentState"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>assessmentState</b> property of the <a>Assessment</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.Filter_DataCollected"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>dataCollected</b> property of the <a>Assessment</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.DurationRange_Maximum"> <summary> <para> <para>The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.EndTimeRange_Maximum"> <summary> <para> <para>The maximum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.StartTimeRange_Maximum"> <summary> <para> <para>The maximum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.DurationRange_Minimum"> <summary> <para> <para>The minimum value of the duration range. Must be greater than zero.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.EndTimeRange_Minimum"> <summary> <para> <para>The minimum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.StartTimeRange_Minimum"> <summary> <para> <para>The minimum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentListCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>ListAssessments</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentTelemetryCmdlet"> <summary> Returns the metadata about the telemetry (application behavioral data) for the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAssessmentTelemetryCmdlet.AssessmentArn"> <summary> <para> <para>The ARN specifying the assessment the telemetry of which you want to obtain.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet"> <summary> Lists the assessments attached to the rules package specified by the rules package ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.Filter_AssessmentNamePattern"> <summary> <para> <para>For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the <b>assessmentName</b> property of the <a>Assessment</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.Filter_AssessmentState"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>assessmentState</b> property of the <a>Assessment</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.Filter_DataCollected"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>dataCollected</b> property of the <a>Assessment</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.DurationRange_Maximum"> <summary> <para> <para>The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.EndTimeRange_Maximum"> <summary> <para> <para>The maximum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.StartTimeRange_Maximum"> <summary> <para> <para>The maximum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.DurationRange_Minimum"> <summary> <para> <para>The minimum value of the duration range. Must be greater than zero.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.EndTimeRange_Minimum"> <summary> <para> <para>The minimum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.StartTimeRange_Minimum"> <summary> <para> <para>The minimum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.RulesPackageArn"> <summary> <para> <para>The ARN specifying the rules package whose assessments you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedAssessmentCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>ListAttachedAssessments</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedRulesPackageCmdlet"> <summary> Lists the rules packages attached to the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedRulesPackageCmdlet.AssessmentArn"> <summary> <para> <para>The ARN specifying the assessment whose rules packages you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedRulesPackageCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSAttachedRulesPackageCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>ListAttachedRulesPackages</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSCrossAccountAccessRoleCmdlet"> <summary> Describes the IAM role that enables Inspector to access your AWS account. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSFindingCmdlet"> <summary> Describes the finding specified by the finding ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingCmdlet.FindingArn"> <summary> <para> <para>The ARN specifying the finding that you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet"> <summary> Lists findings generated by the assessment run specified by the run ARNs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet.Filter_Attribute"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>attributes</b> property of the <a>Finding</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet.Filter_RuleName"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>ruleName</b> property of the <a>Finding</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet.Filter_RulesPackageArn"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>rulesPackageArn</b> property of the <a>Finding</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet.RunArn"> <summary> <para> <para>The ARNs of the assessment runs that generate the findings that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet.Filter_Severity"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>severity</b> property of the <a>Finding</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet.Filter_UserAttribute"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>userAttributes</b> property of the <a>Finding</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSFindingListCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>ListFindings</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSLocalizedTextCmdlet"> <summary> Translates a textual identifier into a user-readable text in a specified locale. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSLocalizedTextCmdlet.Locale"> <summary> <para> <para>The locale that you want to translate a textual identifier into.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSLocalizedTextCmdlet.LocalizedText"> <summary> <para> <para>A list of textual identifiers.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSResourceGroupCmdlet"> <summary> Describes the resource group specified by the resource group ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSResourceGroupCmdlet.ResourceGroupArn"> <summary> <para> <para>The ARN specifying the resource group that you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSResourceGroupAgentPreviewCmdlet"> <summary> Previews the agents installed on the EC2 instances that are included in the application created with the specified resource group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSResourceGroupAgentPreviewCmdlet.ResourceGroupArn"> <summary> <para> <para>The ARN of the resource group that is used to create an application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSResourceGroupAgentPreviewCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSResourceGroupAgentPreviewCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>PreviewAgentsForResourceGroup</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSRulesPackageCmdlet"> <summary> Describes the rules package specified by the rules package ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRulesPackageCmdlet.RulesPackageArn"> <summary> <para> <para>The ARN specifying the rules package that you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSRulesPackageListCmdlet"> <summary> Lists all available Inspector rules packages. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRulesPackageListCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRulesPackageListCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>ListRulesPackages</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSRunCmdlet"> <summary> Describes the assessment run specified by the run ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunCmdlet.RunArn"> <summary> <para> <para>The ARN specifying the assessment run that you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet"> <summary> Lists the assessment runs associated with the assessments specified by the assessment ARNs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.AssessmentArn"> <summary> <para> <para>The ARNs specifying the assessments whose runs you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.CompletionTime_Maximum"> <summary> <para> <para>The maximum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.CreationTime_Maximum"> <summary> <para> <para>The maximum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.CompletionTime_Minimum"> <summary> <para> <para>The minimum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.CreationTime_Minimum"> <summary> <para> <para>The minimum value of the timestamp range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.Filter_RulesPackage"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must match a list of values of the <b>rulesPackages</b> property of the <a>Run</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.Filter_RunNamePattern"> <summary> <para> <para>For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the <b>runName</b> property of the <a>Run</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.Filter_RunState"> <summary> <para> <para>For a record to match a filter, the value specified for this data type property must be the exact match of the value of the <b>runState</b> property of the <a>Run</a> data type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.MaxResult"> <summary> <para> <para>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSRunListCmdlet.NextToken"> <summary> <para> <para>You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the <b>ListRuns</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from previous response to continue listing data.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.GetINSTagListForResourceCmdlet"> <summary> Lists all tags associated with a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.GetINSTagListForResourceCmdlet.ResourceArn"> <summary> <para> <para>The ARN specifying the resource whose tags you want to list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.INS.NewINSApplicationCmdlet"> <summary> Creates a new application using the resource group ARN generated by <a>CreateResourceGroup</a>. You can create up to 50 applications per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see <a href="https://docs.aws.amazon.com/inspector/latest/userguide//inspector_applications.html"> Inspector Applications.</a> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSApplicationCmdlet.ApplicationName"> <summary> <para> <para>The user-defined name identifying the application that you want to create. The name must be unique within the AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSApplicationCmdlet.ResourceGroupArn"> <summary> <para> <para>The ARN specifying the resource group that is used to create the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSApplicationCmdlet.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.INS.NewINSAssessmentCmdlet"> <summary> Creates an assessment for the application specified by the application ARN. You can create up to 500 assessments per AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSAssessmentCmdlet.ApplicationArn"> <summary> <para> <para>The ARN specifying the application for which you want to create an assessment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSAssessmentCmdlet.AssessmentName"> <summary> <para> <para>The user-defined name identifying the assessment that you want to create. You can create several assessments for an application. The names of the assessments corresponding to a particular application must be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSAssessmentCmdlet.DurationInSecond"> <summary> <para> <para>The duration of the assessment in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSAssessmentCmdlet.UserAttributesForFinding"> <summary> <para> <para>The user-defined attributes that are assigned to every finding generated by running this assessment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSAssessmentCmdlet.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.INS.NewINSResourceGroupCmdlet"> <summary> Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Inspector application. The created resource group is then used to create an Inspector application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSResourceGroupCmdlet.ResourceGroupTag"> <summary> <para> <para>A collection of keys and an array of possible values in JSON format.</para><para>For example, [{ "key1" : ["Value1","Value2"]},{"Key2": ["Value3"]}]</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.NewINSResourceGroupCmdlet.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.INS.RegisterINSCrossAccountAccessRoleCmdlet"> <summary> Register the role that Inspector uses to list your EC2 instances during the assessment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RegisterINSCrossAccountAccessRoleCmdlet.RoleArn"> <summary> <para> The ARN of the IAM role that Inspector uses to list your EC2 instances during the assessment. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RegisterINSCrossAccountAccessRoleCmdlet.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.INS.RemoveINSApplicationCmdlet"> <summary> Deletes the application specified by the application ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSApplicationCmdlet.ApplicationArn"> <summary> <para> <para>The ARN specifying the application that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSApplicationCmdlet.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.INS.RemoveINSAssessmentCmdlet"> <summary> Deletes the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSAssessmentCmdlet.AssessmentArn"> <summary> <para> <para>The ARN specifying the assessment that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSAssessmentCmdlet.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.INS.RemoveINSAssessmentAndRulesPackageCmdlet"> <summary> Detaches the rules package specified by the rules package ARN from the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSAssessmentAndRulesPackageCmdlet.AssessmentArn"> <summary> <para> <para>The ARN specifying the assessment from which you want to detach a rules package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSAssessmentAndRulesPackageCmdlet.RulesPackageArn"> <summary> <para> <para>The ARN specifying the rules package that you want to detach from the assessment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSAssessmentAndRulesPackageCmdlet.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.INS.RemoveINSFindingAttributeCmdlet"> <summary> Removes the entire attribute (key and value pair) from the findings specified by the finding ARNs where an attribute with the specified key exists. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSFindingAttributeCmdlet.AttributeKey"> <summary> <para> <para>The array of attribute keys that you want to remove from specified findings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSFindingAttributeCmdlet.FindingArn"> <summary> <para> <para>The ARNs specifying the findings that you want to remove attributes from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSFindingAttributeCmdlet.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.INS.RemoveINSRunCmdlet"> <summary> Deletes the assessment run specified by the run ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSRunCmdlet.RunArn"> <summary> <para> <para>The ARN specifying the assessment run that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.RemoveINSRunCmdlet.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.INS.SetINSResourceTagCmdlet"> <summary> Sets tags (key and value pairs) to the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.SetINSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the assessment that you want to set tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.SetINSResourceTagCmdlet.Tag"> <summary> <para> <para>A collection of key and value pairs that you want to set to an assessment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.SetINSResourceTagCmdlet.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.INS.StartINSAssessmentCmdlet"> <summary> Starts the analysis of the application’s behavior against selected rule packages for the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.StartINSAssessmentCmdlet.AssessmentArn"> <summary> <para> <para>The ARN of the assessment that you want to run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.StartINSAssessmentCmdlet.RunName"> <summary> <para> <para>A name specifying the run of the assessment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.StartINSAssessmentCmdlet.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.INS.StartINSDataCollectionCmdlet"> <summary> Starts data collection for the assessment specified by the assessment ARN. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.StartINSDataCollectionCmdlet.AssessmentArn"> <summary> <para> <para>The ARN of the assessment for which you want to start the data collection process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.StartINSDataCollectionCmdlet.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.INS.StopINSDataCollectionCmdlet"> <summary> Stop data collection for the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.StopINSDataCollectionCmdlet.AssessmentArn"> <summary> <para> <para>The ARN of the assessment for which you want to stop the data collection process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.StopINSDataCollectionCmdlet.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.INS.UpdateINSApplicationCmdlet"> <summary> Updates application specified by the application ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.UpdateINSApplicationCmdlet.ApplicationArn"> <summary> <para> <para>Application ARN that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.UpdateINSApplicationCmdlet.ApplicationName"> <summary> <para> <para>Application name that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.UpdateINSApplicationCmdlet.ResourceGroupArn"> <summary> <para> <para>The resource group ARN that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.UpdateINSApplicationCmdlet.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.INS.UpdateINSAssessmentCmdlet"> <summary> Updates the assessment specified by the assessment ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.UpdateINSAssessmentCmdlet.AssessmentArn"> <summary> <para> <para>Asessment ARN that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.UpdateINSAssessmentCmdlet.AssessmentName"> <summary> <para> <para>Assessment name that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.UpdateINSAssessmentCmdlet.DurationInSecond"> <summary> <para> <para>Assessment duration in seconds that you want to update. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.INS.UpdateINSAssessmentCmdlet.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.IOT.AddIOTPrincipalPolicyCmdlet"> <summary> Attaches the specified policy to the specified principal (certificate or other credential). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet.Principal"> <summary> <para> <para>The principal which can be a certificate ARN (as returned from the CreateCertificate operation) or a Cognito ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet.PassThru"> <summary> Returns the value passed to the Principal parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTPrincipalPolicyCmdlet.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.IOT.AddIOTThingPrincipalCmdlet"> <summary> Attaches the specified principal to the specified thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet.Principal"> <summary> <para> <para>The principal (certificate or other credential).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.AddIOTThingPrincipalCmdlet.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.IOT.ConfirmIOTCertificateTransferCmdlet"> <summary> Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. <para> To check for pending certificate transfers, call <a>ListCertificates</a> to enumerate your certificates. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet.SetAsActive"> <summary> <para> <para>Specifies whether the certificate is active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.ConfirmIOTCertificateTransferCmdlet.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.IOT.DenyIOTCertificateTransferCmdlet"> <summary> Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from <b>PENDING_TRANFER</b> to <b>INACTIVE</b>. <para> To check for pending certificate transfers, call <a>ListCertificates</a> to enumerate your certificates. </para><para> This operation can only be called by the transfer destination. Once called, the certificate will be returned to the source's account in the INACTIVE state. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DenyIOTCertificateTransferCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DenyIOTCertificateTransferCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.DenyIOTCertificateTransferCmdlet.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.IOT.GetIOTCertificateCmdlet"> <summary> Gets information about the specified certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListCmdlet"> <summary> Lists your certificates. <para> The results are paginated with a default page size of 25. You can retrieve additional results using the returned marker. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListCmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTCertificateListCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTEndpointCmdlet"> <summary> Returns a unique URL specific to the AWS account making the call. The URL points to the AWS IoT data plane endpoint. The customer-specific endpoint should be provided to all data plane operations. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTLoggingOptionsCmdlet"> <summary> Gets the logging options. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyCmdlet"> <summary> Gets information about the specified policy with the policy document of the default version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyListCmdlet"> <summary> Lists your policies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyListCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyListCmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If true, the results are returned in ascending creation order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyListCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionCmdlet"> <summary> Gets information about the specified policy version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionCmdlet.PolicyVersionId"> <summary> <para> <para>The policy version ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionListCmdlet"> <summary> Lists the versions of the specified policy, and identifies the default version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPolicyVersionListCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet"> <summary> Lists the policies attached to the specified principal. If you use an Amazon Cognito identity, the ID needs to be in <a href="http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax">Amazon Cognito Identity format</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet.PageSize"> <summary> <para> <para>The result page size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet.Principal"> <summary> <para> <para>The principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet.AscendingOrder"> <summary> <para> <para>Specifies the order for results. If true, results are returned in ascending creation order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalPolicyListCmdlet.Marker"> <summary> <para> <para>The marker for the next set of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalThingListCmdlet"> <summary> Lists the things associated with the specified principal. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTPrincipalThingListCmdlet.Principal"> <summary> <para> <para>The principal.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingCmdlet"> <summary> Gets information about the specified thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet"> <summary> Lists your things. You can pass an AttributeName and/or AttributeValue to filter your things. For example: "ListThings where AttributeName=Color and AttributeValue=Red" </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.AttributeName"> <summary> <para> <para>The attribute name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.AttributeValue"> <summary> <para> <para>The attribute value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.Marker"> <summary> <para> <para>The token for the next value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingPrincipalListCmdlet"> <summary> Lists the principals associated with the specified thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTThingPrincipalListCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleCmdlet"> <summary> Gets information about the specified rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet"> <summary> Lists the rules for the specific topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet.RuleDisabled"> <summary> <para> <para>Specifies whether the rule is disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet.Topic"> <summary> <para> <para>The topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet.Marker"> <summary> <para> <para>A token used to retrieve the next value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.GetIOTTopicRuleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTCertificateFromCsrCmdlet"> <summary> Creates an X.509 certificate using the specified certificate signing request. <para><b>Note</b> Reusing the same certificate signing request (CSR) results in a distinct certificate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTCertificateFromCsrCmdlet.CertificateSigningRequest"> <summary> <para> <para>The certificate signing request (CSR).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTCertificateFromCsrCmdlet.SetAsActive"> <summary> <para> <para>Specifies whether the certificate is active.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IOT.NewIOTKeysAndCertificateCmdlet"> <summary> Creates a 2048 bit RSA key pair and issues an X.509 certificate using the issued public key. <para><b>Note</b> This is the only time AWS IoT issues the private key for this certificate. It is important to keep track of the private key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTKeysAndCertificateCmdlet.SetAsActive"> <summary> <para> <para>Specifies whether the certificate is active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTKeysAndCertificateCmdlet.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.IOT.NewIOTPolicyCmdlet"> <summary> Creates an AWS IoT policy. <para> The created policy is the default version for the policy. This operation creates a policy version with a version identifier of <b>1</b> and sets <b>1</b> as the policy's default version. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyCmdlet.PolicyDocument"> <summary> <para> <para>The JSON document that describes the policy. The length of the <b>policyDocument</b> must be a minimum length of 1, with a maximum length of 2048, excluding whitespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyCmdlet.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.IOT.NewIOTPolicyVersionCmdlet"> <summary> Creates a new version of the specified AWS IoT policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet.PolicyDocument"> <summary> <para> <para>The JSON document that describes the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet.SetAsDefault"> <summary> <para> <para>Specifies whether the policy version is set as the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTPolicyVersionCmdlet.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.IOT.NewIOTThingCmdlet"> <summary> Creates a thing in the thing registry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet.AttributePayload_Attribute"> <summary> <para> <para>A JSON string containing up to three key-value pair in JSON format.</para><para>For example: {\"attributes\":{\"string1\":\"string2\”}}</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTThingCmdlet.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.IOT.NewIOTTopicRuleCmdlet"> <summary> Creates a rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_Action"> <summary> <para> <para>The actions associated with the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_Description"> <summary> <para> <para>The description of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_RuleDisabled"> <summary> <para> <para>Specifies whether the rule is disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.TopicRulePayload_Sql"> <summary> <para> <para>The SQL statement used to query the topic. For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference">AWS IoT SQL Reference</a> in the <i>AWS IoT Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.NewIOTTopicRuleCmdlet.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.IOT.RemoveIOTCertificateCmdlet"> <summary> Deletes the specified certificate. <para> A certificate cannot be deleted if it has a policy attached to it. To delete a certificate, first detach all policies using the <a>DetachPrincipalPolicy</a> operation. </para><para> In addition, a certificate cannot be deleted if it is in ACTIVE status. To delete a certificate, first change the status to INACTIVE using the <a>UpdateCertificate</a> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCertificateCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTCertificateCmdlet.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.IOT.RemoveIOTPolicyCmdlet"> <summary> Deletes the specified policy. <para> A policy cannot be deleted if: </para><para> - it has non-default versions </para><para> - it is attached to any certificate </para><para> To delete a policy: </para><para> - First delete all the non-default versions of the policy using the <a>DeletePolicyVersion</a> API. </para><para> - Detach it from any certificate using the <a>DetachPrincipalPolicy</a> API. </para><para> When a policy is deleted, its default version is deleted with it. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyCmdlet.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.IOT.RemoveIOTPolicyVersionCmdlet"> <summary> Deletes the specified version of the specified policy. The default version of the policy cannot be deleted. <para> To delete the default version use the <a>DeletePolicy</a> API or mark the policy as non-default and then delete it. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet.PolicyVersionId"> <summary> <para> <para>The policy version ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPolicyVersionCmdlet.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.IOT.RemoveIOTPrincipalPolicyCmdlet"> <summary> Removes the specified policy from the specified certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPrincipalPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy to detach.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPrincipalPolicyCmdlet.Principal"> <summary> <para> <para>The principal</para><para>If the principal is a certificate, specify the certificate ARN. If the principal is a Cognito identity specify the identity ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTPrincipalPolicyCmdlet.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.IOT.RemoveIOTThingCmdlet"> <summary> Deletes the specified thing from the Thing Registry. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingCmdlet.ThingName"> <summary> <para> <para>The thing name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingCmdlet.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.IOT.RemoveIOTThingPrincipalCmdlet"> <summary> Detaches the specified principal from the specified thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet.Principal"> <summary> <para> <para>The principal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet.ThingName"> <summary> <para> <para>The name of the thing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTThingPrincipalCmdlet.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.IOT.RemoveIOTTopicRuleCmdlet"> <summary> Deletes the specified rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTTopicRuleCmdlet.PassThru"> <summary> Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RemoveIOTTopicRuleCmdlet.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.IOT.RequestIOTCertificateTransferCmdlet"> <summary> Transfers the specified certificate to the specified AWS account. <para> You can cancel the transfer until it is acknowledged by the recipient. </para><para> No notification is sent to the transfer destination's account, it is up to the caller to notify the transfer target. </para><para> The certificate being transferred must not be in the ACTIVE state. It can be deactivated using the UpdateCertificate API. </para><para> The certificate must not have any policies attached to it. These can be detached using the <a>DetachPrincipalPolicy</a> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RequestIOTCertificateTransferCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RequestIOTCertificateTransferCmdlet.TargetAwsAccount"> <summary> <para> <para>The AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.RequestIOTCertificateTransferCmdlet.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.IOT.SetIOTDefaultPolicyVersionCmdlet"> <summary> Sets the specified policy version as the default for the specified policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet.PolicyName"> <summary> <para> <para>The policy name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet.PolicyVersionId"> <summary> <para> <para>The policy version ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTDefaultPolicyVersionCmdlet.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.IOT.SetIOTLoggingOptionsCmdlet"> <summary> Sets the logging options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTLoggingOptionsCmdlet.LoggingOptionsPayload_LogLevel"> <summary> <para> <para>The logging level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTLoggingOptionsCmdlet.LoggingOptionsPayload_RoleArn"> <summary> <para> <para>The ARN of the IAM role that grants access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTLoggingOptionsCmdlet.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.IOT.SetIOTTopicRuleCmdlet"> <summary> Replaces the specified rule. You must specify all parameters for the new rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_Action"> <summary> <para> <para>The actions associated with the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_Description"> <summary> <para> <para>The description of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_RuleDisabled"> <summary> <para> <para>Specifies whether the rule is disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.RuleName"> <summary> <para> <para>The name of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.TopicRulePayload_Sql"> <summary> <para> <para>The SQL statement used to query the topic. For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference">AWS IoT SQL Reference</a> in the <i>AWS IoT Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.PassThru"> <summary> Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.SetIOTTopicRuleCmdlet.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.IOT.StopIOTCertificateTransferCmdlet"> <summary> Cancels a pending transfer for the specified certificate. <para><b>Note</b> Only the transfer source account can use this operation to cancel a transfer (transfer destinations can use <a>RejectCertificateTransfer</a> instead). After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. Once the destination account has accepted the transfer, the transfer may no longer be cancelled. </para><para> After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTCertificateTransferCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTCertificateTransferCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.StopIOTCertificateTransferCmdlet.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.IOT.UpdateIOTCertificateCmdlet"> <summary> Updates the status of the specified certificate. This operation is idempotent. <para> Moving a cert from the ACTIVE state (including REVOKED) will NOT disconnect currently-connected devices, although these devices will be unable to reconnect. </para><para> The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet.CertificateId"> <summary> <para> <para>The ID of the certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet.NewStatus"> <summary> <para> <para>The new status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet.PassThru"> <summary> Returns the value passed to the CertificateId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTCertificateCmdlet.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.IOT.UpdateIOTThingCmdlet"> <summary> Updates the data for a thing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.AttributePayload_Attribute"> <summary> <para> <para>A JSON string containing up to three key-value pair in JSON format.</para><para>For example: {\"attributes\":{\"string1\":\"string2\”}}</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.ThingName"> <summary> <para> <para>The thing name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.PassThru"> <summary> Returns the value passed to the ThingName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IOT.UpdateIOTThingCmdlet.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.KMS.DisableKMSGrantCmdlet"> <summary> Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: <ul><li>The account that created the grant</li><li>The <code>RetiringPrincipal</code>, if present</li><li>The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is a grantee operation</li></ul> The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the <code>CreateGrant</code> function. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSGrantCmdlet.GrantId"> <summary> <para> <para> Unique identifier of the grant to be retired. The grant ID is returned by the <code>CreateGrant</code> function. <ul><li>Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSGrantCmdlet.GrantToken"> <summary> <para> <para>Token that identifies the grant to be retired.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSGrantCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSGrantCmdlet.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.KMS.DisableKMSKeyCmdlet"> <summary> Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSKeyCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSKeyCmdlet.PassThru"> <summary> Returns the value passed to the KeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSKeyCmdlet.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.KMS.DisableKMSKeyRotationCmdlet"> <summary> Disables rotation of the specified key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSKeyRotationCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSKeyRotationCmdlet.PassThru"> <summary> Returns the value passed to the KeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.DisableKMSKeyRotationCmdlet.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.KMS.EnableKMSKeyCmdlet"> <summary> Marks a key as enabled, thereby permitting its use. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.EnableKMSKeyCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.EnableKMSKeyCmdlet.PassThru"> <summary> Returns the value passed to the KeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.EnableKMSKeyCmdlet.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.KMS.EnableKMSKeyRotationCmdlet"> <summary> Enables rotation of the specified customer master key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.EnableKMSKeyRotationCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.EnableKMSKeyRotationCmdlet.PassThru"> <summary> Returns the value passed to the KeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.EnableKMSKeyRotationCmdlet.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.KMS.GetKMSAliasesCmdlet"> <summary> Lists all of the key aliases in the account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSAliasesCmdlet.Limit"> <summary> <para> <para>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</para><para>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSAliasesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of <code>NextMarker</code> from the response you just received.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.GetKMSGrantsCmdlet"> <summary> List the grants for a specified key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSGrantsCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSGrantsCmdlet.Limit"> <summary> <para> <para>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</para><para>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSGrantsCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of <code>NextMarker</code> from the response you just received.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyCmdlet"> <summary> Provides detailed information about the specified customer master key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyCmdlet.GrantToken"> <summary> <para> <para>A list of grant tokens.</para><para>For more information, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li><li>Alias Name Example - alias/MyAliasName</li></ul></para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyPoliciesCmdlet"> <summary> Retrieves a list of policies attached to a key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyPoliciesCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li><li>Alias Name Example - alias/MyAliasName</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyPoliciesCmdlet.Limit"> <summary> <para> <para>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</para><para>This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</para><para>Currently only 1 policy can be attached to a key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyPoliciesCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of <code>NextMarker</code> from the response you just received.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyPolicyCmdlet"> <summary> Retrieves a policy attached to the specified key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyPolicyCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyPolicyCmdlet.PolicyName"> <summary> <para> <para>String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling <a>ListKeyPolicies</a>. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyRotationStatusCmdlet"> <summary> Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeyRotationStatusCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeysCmdlet"> <summary> Lists the customer master keys. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeysCmdlet.Limit"> <summary> <para> <para>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</para><para>This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSKeysCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of <code>NextMarker</code> from the response you just received.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.GetKMSRetirableGrantCmdlet"> <summary> Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified. <para> A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSRetirableGrantCmdlet.RetiringPrincipal"> <summary> <para> <para>The retiring principal for which to list grants.</para><para>To specify the retiring principal, use the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSRetirableGrantCmdlet.Limit"> <summary> <para> <para>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</para><para>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.GetKMSRetirableGrantCmdlet.Marker"> <summary> <para> <para>Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of <code>NextMarker</code> from the response you just received.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSDecryptCmdlet"> <summary> Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions: <ul><li><a>GenerateDataKey</a></li><li><a>GenerateDataKeyWithoutPlaintext</a></li><li><a>Encrypt</a></li></ul><para> Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant <code>Decrypt</code> permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant <code>Decrypt</code> access in an IAM user policy. Instead grant <code>Decrypt</code> access only in key policies. If you must grant <code>Decrypt</code> access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSDecryptCmdlet.CiphertextBlob"> <summary> <para> <para>Ciphertext to be decrypted. The blob includes metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSDecryptCmdlet.EncryptionContext"> <summary> <para> <para>The encryption context. If this was specified in the <a>Encrypt</a> function, it must be specified here or the decryption operation will fail. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html">Encryption Context</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSDecryptCmdlet.GrantToken"> <summary> <para> <para>A list of grant tokens.</para><para>For more information, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSEncryptCmdlet"> <summary> Encrypts plaintext into ciphertext by using a customer master key. The <code>Encrypt</code> function has two primary use cases: <ul><li>You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.</li><li>If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data. </li></ul><para> Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the <a>GenerateDataKey</a> or <a>GenerateDataKeyWithoutPlaintext</a> function. Data keys don't need to be encrypted again by calling <code>Encrypt</code>. </para><para> If you want to encrypt data locally in your application, you can use the <code>GenerateDataKey</code> function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSEncryptCmdlet.EncryptionContext"> <summary> <para> <para>Name/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the <code>Decrypt</code> API or decryption will fail. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html">Encryption Context</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSEncryptCmdlet.GrantToken"> <summary> <para> <para>A list of grant tokens.</para><para>For more information, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSEncryptCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li><li>Alias Name Example - alias/MyAliasName</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSEncryptCmdlet.Plaintext"> <summary> <para> <para>Data to be encrypted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSEncryptCmdlet.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.KMS.InvokeKMSReEncryptCmdlet"> <summary> Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext. <para> Unlike other actions, <code>ReEncrypt</code> is authorized twice - once as <code>ReEncryptFrom</code> on the source key and once as <code>ReEncryptTo</code> on the destination key. We therefore recommend that you include the <code>"action":"kms:ReEncrypt*"</code> statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the <a>PutKeyPolicy</a> function. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSReEncryptCmdlet.CiphertextBlob"> <summary> <para> <para>Ciphertext of the data to re-encrypt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSReEncryptCmdlet.DestinationEncryptionContext"> <summary> <para> <para>Encryption context to be used when the data is re-encrypted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSReEncryptCmdlet.DestinationKeyId"> <summary> <para> <para>A unique identifier for the customer master key used to re-encrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li><li>Alias Name Example - alias/MyAliasName</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSReEncryptCmdlet.GrantToken"> <summary> <para> <para>A list of grant tokens.</para><para>For more information, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSReEncryptCmdlet.SourceEncryptionContext"> <summary> <para> <para>Encryption context used to encrypt and decrypt the data specified in the <code>CiphertextBlob</code> parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.InvokeKMSReEncryptCmdlet.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.KMS.NewKMSAliasCmdlet"> <summary> Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). <para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para><para> To map an alias to a different key, call <a>UpdateAlias</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSAliasCmdlet.AliasName"> <summary> <para> <para>String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSAliasCmdlet.TargetKeyId"> <summary> <para> <para>An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSAliasCmdlet.PassThru"> <summary> Returns the value passed to the TargetKeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSAliasCmdlet.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.KMS.NewKMSDataKeyCmdlet"> <summary> Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the <code>Plaintext</code> field of the response object and an encrypted copy of the key in the <code>CiphertextBlob</code> field. The key is encrypted by using the master key specified by the <code>KeyId</code> field. To decrypt the encrypted key, pass it to the <code>Decrypt</code> API. <para> We recommend that you use the following pattern to locally encrypt data: call the <code>GenerateDataKey</code> API, use the key returned in the <code>Plaintext</code> response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the <code>CiphertextBlob</code> field) alongside of the locally encrypted data. </para><note>You should not call the <code>Encrypt</code> function to re-encrypt your data keys within a region. <code>GenerateDataKey</code> always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice. </note><para> If you decide to use the optional <code>EncryptionContext</code> parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the <code>Decrypt</code> API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html">Encryption Context</a>. </para><para> To decrypt data, pass the encrypted data key to the <code>Decrypt</code> API. <code>Decrypt</code> uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyCmdlet.EncryptionContext"> <summary> <para> <para>Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyCmdlet.GrantToken"> <summary> <para> <para>A list of grant tokens.</para><para>For more information, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li><li>Alias Name Example - alias/MyAliasName</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyCmdlet.KeySpec"> <summary> <para> <para>Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyCmdlet.NumberOfBytes"> <summary> <para> <para>Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the <code>KeySpec</code> parameter instead. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyCmdlet.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.KMS.NewKMSDataKeyWithoutPlaintextCmdlet"> <summary> Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like <a>GenerateDataKey</a>. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyWithoutPlaintextCmdlet.EncryptionContext"> <summary> <para> <para>Name:value pair that contains additional data to be authenticated during the encryption and decryption processes. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyWithoutPlaintextCmdlet.GrantToken"> <summary> <para> <para>A list of grant tokens.</para><para>For more information, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyWithoutPlaintextCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li><li>Alias Name Example - alias/MyAliasName</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyWithoutPlaintextCmdlet.KeySpec"> <summary> <para> <para>Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyWithoutPlaintextCmdlet.NumberOfBytes"> <summary> <para> <para>Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the <code>KeySpec</code> parameter instead. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSDataKeyWithoutPlaintextCmdlet.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.KMS.NewKMSGrantCmdlet"> <summary> Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies. <para> For more information about grants, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.Constraints_EncryptionContextEqual"> <summary> <para> <para>Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.Constraints_EncryptionContextSubset"> <summary> <para> <para>Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.GranteePrincipal"> <summary> <para> <para>The principal that is given permission to perform the operations that the grant permits.</para><para>To specify the principal, use the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>AWS General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.GrantToken"> <summary> <para> <para>A list of grant tokens.</para><para>For more information, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.KeyId"> <summary> <para> <para>The unique identifier for the customer master key (CMK) that the grant applies to.</para><para>To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples: <ul><li>Globally unique key ID: 12345678-1234-1234-1234-123456789012</li><li>Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.Name"> <summary> <para> <para>A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.</para><para>When this value is absent, all <code>CreateGrant</code> requests result in a new grant with a unique <code>GrantId</code> even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the <code>CreateGrant</code> request.</para><para>When this value is present, you can retry a <code>CreateGrant</code> request with identical parameters; if the grant already exists, the original <code>GrantId</code> is returned without creating a new grant. Note that the returned grant token is unique with every <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is returned. All grant tokens obtained in this way can be used interchangeably.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.Operation"> <summary> <para> <para>A list of operations that the grant permits. The list can contain any combination of one or more of the following values: <ul><li>Decrypt</li><li>Encrypt</li><li>GenerateDataKey</li><li>GenerateDataKeyWithoutPlaintext</li><li>ReEncryptFrom</li><li>ReEncryptTo</li><li>CreateGrant</li><li>RetireGrant</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.RetiringPrincipal"> <summary> <para> <para>The principal that is given permission to retire the grant by using <a>RetireGrant</a> operation.</para><para>To specify the principal, use the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>AWS General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSGrantCmdlet.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.KMS.NewKMSKeyCmdlet"> <summary> Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see <a>GenerateDataKey</a> and <a>GenerateDataKeyWithoutPlaintext</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSKeyCmdlet.Description"> <summary> <para> <para>Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSKeyCmdlet.KeyUsage"> <summary> <para> <para>Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSKeyCmdlet.Policy"> <summary> <para> <para>Policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSKeyCmdlet.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.KMS.NewKMSRandomCmdlet"> <summary> Generates an unpredictable byte string. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSRandomCmdlet.NumberOfBytes"> <summary> <para> <para>Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. The current limit is 1024 bytes. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.NewKMSRandomCmdlet.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.KMS.RemoveKMSAliasCmdlet"> <summary> Deletes the specified alias. To map an alias to a different key, call <a>UpdateAlias</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RemoveKMSAliasCmdlet.AliasName"> <summary> <para> <para>The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RemoveKMSAliasCmdlet.PassThru"> <summary> Returns the value passed to the AliasName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RemoveKMSAliasCmdlet.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.KMS.RequestKMSKeyDeletionCmdlet"> <summary> Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it. <important><para> Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>. </para></important><para> For more information about scheduling a CMK for deletion, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RequestKMSKeyDeletionCmdlet.KeyId"> <summary> <para> <para>The unique identifier for the customer master key (CMK) to delete.</para><para>To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul><li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li><li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li></ul></para><para>To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RequestKMSKeyDeletionCmdlet.PendingWindowInDay"> <summary> <para> <para>The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).</para><para>This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RequestKMSKeyDeletionCmdlet.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.KMS.RevokeKMSGrantCmdlet"> <summary> Revokes a grant. You can revoke a grant to actively deny operations that depend on it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RevokeKMSGrantCmdlet.GrantId"> <summary> <para> <para>Identifier of the grant to be revoked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RevokeKMSGrantCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RevokeKMSGrantCmdlet.PassThru"> <summary> Returns the value passed to the KeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.RevokeKMSGrantCmdlet.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.KMS.StopKMSKeyDeletionCmdlet"> <summary> Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>. <para> For more information about scheduling and canceling deletion of a CMK, go to <a href="http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.StopKMSKeyDeletionCmdlet.KeyId"> <summary> <para> <para>The unique identifier for the customer master key (CMK) for which to cancel deletion.</para><para>To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul><li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li><li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li></ul></para><para>To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.StopKMSKeyDeletionCmdlet.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.KMS.UpdateKMSAliasCmdlet"> <summary> Updates an alias to map it to a different key. <para> An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. </para><para> An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). </para><para> The alias and the key it is mapped to must be in the same AWS account and the same region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.UpdateKMSAliasCmdlet.AliasName"> <summary> <para> <para>String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.UpdateKMSAliasCmdlet.TargetKeyId"> <summary> <para> <para>Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para><para>You can call <a>ListAliases</a> to verify that the alias is mapped to the correct <code>TargetKeyId</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.UpdateKMSAliasCmdlet.PassThru"> <summary> Returns the value passed to the TargetKeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.UpdateKMSAliasCmdlet.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.KMS.UpdateKMSKeyDescriptionCmdlet"> <summary> Updates the description of a key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.UpdateKMSKeyDescriptionCmdlet.Description"> <summary> <para> <para>New description for the key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.UpdateKMSKeyDescriptionCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.UpdateKMSKeyDescriptionCmdlet.PassThru"> <summary> Returns the value passed to the KeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.UpdateKMSKeyDescriptionCmdlet.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.KMS.WriteKMSKeyPolicyCmdlet"> <summary> Attaches a policy to the specified key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.WriteKMSKeyPolicyCmdlet.KeyId"> <summary> <para> <para>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul><li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li><li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.WriteKMSKeyPolicyCmdlet.Policy"> <summary> <para> <para>The policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.WriteKMSKeyPolicyCmdlet.PolicyName"> <summary> <para> <para>Name of the policy to be attached. Currently, the only supported name is "default".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.WriteKMSKeyPolicyCmdlet.PassThru"> <summary> Returns the value passed to the KeyId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KMS.WriteKMSKeyPolicyCmdlet.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.KINF.WriteKINFRecordCmdlet"> <summary> Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use <a>PutRecordBatch</a>. Applications using these operations are referred to as producers. <para> By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <a href="http://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon Kinesis Firehose Limits</a>. </para><para> You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc. </para><para> Amazon Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\n</code>) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination. </para><para> Amazon Kinesis Firehose does not maintain data record ordering. If the destination data needs to be re-ordered by the consumer application, the producer should include some form of sequence number in each data record. </para><para> The <a>PutRecord</a> operation returns a <code>RecordId</code>, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation. </para><para> If the <a>PutRecord</a> operation throws a <code>ServiceUnavailableException</code>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </para><para> Data records sent to Amazon Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.Record_Data"> <summary> <para> <para>The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.Record_Text"> <summary> Text string containing the data to send. Use this parameter, or Record_Data, to define the data to be written. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.DeliveryStreamName"> <summary> <para> <para>The name of the delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordCmdlet.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.KINF.GetKINFDeliveryStreamCmdlet"> <summary> Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call <a>DescribeDeliveryStream</a> to see if the delivery stream is <code>ACTIVE</code> and therefore ready for data to be sent to it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamCmdlet.DeliveryStreamName"> <summary> <para> <para>The name of the delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamCmdlet.ExclusiveStartDestinationId"> <summary> <para> <para>Specifies the destination ID to start returning the destination information. Currently Amazon Kinesis Firehose supports one destination per delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamCmdlet.Limit"> <summary> <para> <para>The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamListCmdlet"> <summary> Lists your delivery streams. <para> The number of delivery streams might be too large to return using a single call to <a>ListDeliveryStreams</a>. You can limit the number of delivery streams returned, using the <code>Limit</code> parameter. To determine whether there are more delivery streams to list, check the value of <code>HasMoreDeliveryStreams</code> in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the <code>ExclusiveStartDeliveryStreamName</code> parameter of a subsequent call. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamListCmdlet.ExclusiveStartDeliveryStreamName"> <summary> <para> <para>The name of the delivery stream to start the list with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.GetKINFDeliveryStreamListCmdlet.Limit"> <summary> <para> <para>The maximum number of delivery streams to list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet"> <summary> Creates a delivery stream. <para><a>CreateDeliveryStream</a> is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>. </para><para> The name of a delivery stream identifies it. You can't have two delivery streams with the same name in the same region. Two delivery streams in different AWS accounts or different regions in the same AWS account can have the same name. </para><para> By default, you can create up to 5 delivery streams per region. </para><para> A delivery stream can only be configured with a single destination, Amazon S3 or Amazon Redshift. For correct <a>CreateDeliveryStream</a> request syntax, specify only one destination configuration parameter: either <code>RedshiftDestinationConfiguration</code> or <code>S3DestinationConfiguration</code></para><para> As part of <code>S3DestinationConfiguration</code>, optional values <code>BufferingHints</code>, <code>EncryptionConfiguration</code>, and <code>CompressionFormat</code> can be provided. By default, if no <code>BufferingHints</code> value is provided, Amazon Kinesis Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that <code>BufferingHints</code> is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. </para><para> A few notes about <code>RedshiftDestinationConfiguration</code>: </para><ul><li>An Amazon Redshift destination requires an S3 bucket as intermediate location, as Amazon Kinesis Firehose first delivers data to S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <code>RedshiftDestinationConfiguration.S3Configuration</code> parameter element.</li><li>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</li><li>We strongly recommend that the username and password provided is used exclusively for Amazon Kinesis Firehose purposes, and that the permissions for the account are restricted for Amazon Redshift <code>INSERT</code> permissions.</li></ul><para> Amazon Kinesis Firehose assumes the IAM role that is configured as part of destinations. The IAM role should allow the Amazon Kinesis Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see <a href="http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3">Amazon S3 Bucket Access</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.DeliveryStreamName"> <summary> <para> <para>The name of the delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.RedshiftDestinationConfiguration"> <summary> <para> <para>The destination in Amazon Redshift. This value cannot be specified if Amazon S3 is the desired destination (see restrictions listed above).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.S3DestinationConfiguration"> <summary> <para> <para>The destination in Amazon S3. This value must be specified if <code>RedshiftDestinationConfiguration</code> is specified (see restrictions listed above).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.NewKINFDeliveryStreamCmdlet.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.KINF.RemoveKINFDeliveryStreamCmdlet"> <summary> Deletes a delivery stream and its data. <para> You can delete a delivery stream only if it is in <code>ACTIVE</code> or <code>DELETING</code> state, and not in the <code>CREATING</code> state. While the deletion request is in process, the delivery stream is in the <code>DELETING</code> state. </para><para> To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>. </para><para> While the delivery stream is <code>DELETING</code> state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet.DeliveryStreamName"> <summary> <para> <para>The name of the delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet.PassThru"> <summary> Returns the value passed to the DeliveryStreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.RemoveKINFDeliveryStreamCmdlet.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.KINF.UpdateKINFDestinationCmdlet"> <summary> Updates the specified destination of the specified delivery stream. <para> This operation can be used to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a given destination (for example, to change the bucket name of the Amazon S3 destination). The update may not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are normally effective within a few minutes. </para><para> If the destination type is the same, Amazon Kinesis Firehose merges the configuration parameters specified in the <a>UpdateDestination</a> request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a> is not specified then the existing <a>EncryptionConfiguration</a> is maintained on the destination. </para><para> If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Amazon Kinesis Firehose does not merge any parameters. In this case, all parameters must be specified. </para><para> Amazon Kinesis Firehose uses the <code>CurrentDeliveryStreamVersionId</code> to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the <code>VersionId</code>. After the update is applied successfully, the <code>VersionId</code> is updated, which can be retrieved with the <a>DescribeDeliveryStream</a> operation. The new <code>VersionId</code> should be uses to set <code>CurrentDeliveryStreamVersionId</code> in the next <a>UpdateDestination</a> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.CurrentDeliveryStreamVersionId"> <summary> <para> <para>Obtain this value from the <code>VersionId</code> result of the <a>DeliveryStreamDescription</a> operation. This value is required, and helps the service to perform conditional operations. For example, if there is a interleaving update and this value is null, then the update destination fails. After the update is successful, the <code>VersionId</code> value is updated. The service then performs a merge of the old configuration with the new configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.DeliveryStreamName"> <summary> <para> <para>The name of the delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.DestinationId"> <summary> <para> <para>The ID of the destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.RedshiftDestinationUpdate"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.S3DestinationUpdate"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.UpdateKINFDestinationCmdlet.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.KINF.WriteKINFRecordBatchCmdlet"> <summary> Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use <a>PutRecord</a>. Applications using these operations are referred to as producers. <para> Each <a>PutRecordBatch</a> request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <a href="http://docs.aws.amazon.com/firehose/latest/dev/limits.html">Amazon Kinesis Firehose Limits</a>. </para><para> You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, and so on. </para><para> Amazon Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\n</code>) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination. </para><para> The <a>PutRecordBatch</a> response includes a count of any failed records, <code>FailedPutCount</code>, and an array of responses, <code>RequestResponses</code>. The <code>FailedPutCount</code> value is a count of records that failed. Each entry in the <code>RequestResponses</code> array gives additional information of the processed record. Each entry in <code>RequestResponses</code> directly correlates with a record in the request array using the same ordering, from the top to the bottom of the request and response. <code>RequestResponses</code> always includes the same number of records as the request array. <code>RequestResponses</code> both successfully and unsuccessfully processed records. Amazon Kinesis Firehose attempts to process all records in each <a>PutRecordBatch</a> request. A single record failure does not stop the processing of subsequent records. </para><para> A successfully processed record includes a <code>RecordId</code> value, which is a unique value identified for the record. An unsuccessfully processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and is one of the following values: <code>ServiceUnavailable</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the error. </para><para> If <code>FailedPutCount</code> is greater than 0 (zero), retry the request. A retry of the entire batch of records is possible; however, we strongly recommend that you inspect the entire response and resend only those records that failed processing. This minimizes duplicate records and also reduces the total bytes sent (and corresponding charges). </para><para> If the <a>PutRecordBatch</a> operation throws a <code>ServiceUnavailableException</code>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </para><para> Data records sent to Amazon Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet.DeliveryStreamName"> <summary> <para> <para>The name of the delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet.Record"> <summary> <para> <para>One or more records.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KINF.WriteKINFRecordBatchCmdlet.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.KIN.AddKINTagsToStreamCmdlet"> <summary> Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags. <para> If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.AddKINTagsToStreamCmdlet.StreamName"> <summary> <para> <para>The name of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.AddKINTagsToStreamCmdlet.Tag"> <summary> <para> <para>The set of key-value pairs to use to create the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.AddKINTagsToStreamCmdlet.PassThru"> <summary> Returns the value passed to the StreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.AddKINTagsToStreamCmdlet.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.KIN.GetKINStreamCmdlet"> <summary> Describes the specified stream. <para> The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream. </para><para> You can limit the number of returned shards using the <code>Limit</code> parameter. The number of shards in a stream may be too large to return from a single call to <code>DescribeStream</code>. You can detect this by using the <code>HasMoreShards</code> flag in the returned output. <code>HasMoreShards</code> is set to <code>true</code> when there is more data available. </para><para><code>DescribeStream</code> is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the <code>ExclusiveStartShardId</code> parameter in a subsequent request to <code>DescribeStream</code>. </para><para><a>DescribeStream</a> has a limit of 10 transactions per second per account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.GetKINStreamCmdlet.ExclusiveStartShardId"> <summary> <para> <para>The shard ID of the shard to start with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.GetKINStreamCmdlet.StreamName"> <summary> <para> <para>The name of the stream to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.GetKINStreamCmdlet.Limit"> <summary> <para> <para>The maximum number of shards to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KIN.GetKINStreamsCmdlet"> <summary> Lists your streams. <para> The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Amazon Kinesis uses the default limit, which is currently 10. </para><para> You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </para><para><a>ListStreams</a> has a limit of 5 transactions per second per account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.GetKINStreamsCmdlet.ExclusiveStartStreamName"> <summary> <para> <para>The name of the stream to start the list with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.GetKINStreamsCmdlet.Limit"> <summary> <para> <para>The maximum number of streams to list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KIN.GetKINTagsForStreamCmdlet"> <summary> Lists the tags for the specified Amazon Kinesis stream. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.GetKINTagsForStreamCmdlet.ExclusiveStartTagKey"> <summary> <para> <para>The key to use as the starting point for the list of tags. If this parameter is set, <code>ListTagsForStream</code> gets all tags that occur after <code>ExclusiveStartTagKey</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.GetKINTagsForStreamCmdlet.StreamName"> <summary> <para> <para>The name of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.GetKINTagsForStreamCmdlet.Limit"> <summary> <para> <para>The number of tags to return. If this number is less than the total number of tags associated with the stream, <code>HasMoreTags</code> is set to <code>true</code>. To list additional tags, set <code>ExclusiveStartTagKey</code> to the last key in the response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KIN.MergeKINShardCmdlet"> <summary> Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards. <para><code>MergeShards</code> is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html">Merge Two Shards</a> in the <i>Amazon Kinesis Developer Guide</i>. </para><para> If the stream is in the <code>ACTIVE</code> state, you can call <code>MergeShards</code>. If a stream is in the <code>CREATING</code>, <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code> returns a <code>ResourceInUseException</code>. If the specified stream does not exist, <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </para><para> You can use <a>DescribeStream</a> to check the state of the stream, which is returned in <code>StreamStatus</code>. </para><para><code>MergeShards</code> is an asynchronous operation. Upon receiving a <code>MergeShards</code> request, Amazon Kinesis immediately returns a response and sets the <code>StreamStatus</code> to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the <code>StreamStatus</code> to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </para><para> You use <a>DescribeStream</a> to determine the shard IDs that are specified in the <code>MergeShards</code> request. </para><para> If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code> or <a>SplitShard</a>, you will receive a <code>LimitExceededException</code>. </para><para><code>MergeShards</code> has limit of 5 transactions per second per account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.MergeKINShardCmdlet.AdjacentShardToMerge"> <summary> <para> <para>The shard ID of the adjacent shard for the merge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.MergeKINShardCmdlet.ShardToMerge"> <summary> <para> <para>The shard ID of the shard to combine with the adjacent shard for the merge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.MergeKINShardCmdlet.StreamName"> <summary> <para> <para>The name of the stream for the merge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.MergeKINShardCmdlet.PassThru"> <summary> Returns the value passed to the StreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.MergeKINShardCmdlet.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.KIN.NewKINStreamCmdlet"> <summary> Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream. <para> You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases. </para><para> The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name. </para><para><code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Amazon Kinesis immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </para><para> You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request if you try to do one of the following: </para><ul><li>Have more than five streams in the <code>CREATING</code> state at any point in time.</li><li>Create more shards than are authorized for your account.</li></ul><para> For the default shard limit for an AWS account, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact AWS Support</a>. </para><para> You can use <code>DescribeStream</code> to check the stream status, which is returned in <code>StreamStatus</code>. </para><para><a>CreateStream</a> has a limit of 5 transactions per second per account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.NewKINStreamCmdlet.ShardCount"> <summary> <para> <para>The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.</para><para>DefaultShardLimit;</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.NewKINStreamCmdlet.StreamName"> <summary> <para> <para>A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name, and two streams in the same AWS account, but in two different regions, can have the same name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.NewKINStreamCmdlet.PassThru"> <summary> Returns the value passed to the StreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.NewKINStreamCmdlet.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.KIN.RemoveKINStreamCmdlet"> <summary> Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception <code>ResourceNotFoundException</code>. <para> If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Amazon Kinesis completes the deletion. </para><para><b>Note:</b> Amazon Kinesis might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete. </para><para> When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream. </para><para> You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>. </para><para><a>DeleteStream</a> has a limit of 5 transactions per second per account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RemoveKINStreamCmdlet.StreamName"> <summary> <para> <para>The name of the stream to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RemoveKINStreamCmdlet.PassThru"> <summary> Returns the value passed to the StreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RemoveKINStreamCmdlet.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.KIN.RemoveKINTagsFromStreamCmdlet"> <summary> Deletes tags from the specified Amazon Kinesis stream. <para> If you specify a tag that does not exist, it is ignored. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RemoveKINTagsFromStreamCmdlet.StreamName"> <summary> <para> <para>The name of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RemoveKINTagsFromStreamCmdlet.TagKey"> <summary> <para> <para>A list of tag keys. Each corresponding tag is removed from the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RemoveKINTagsFromStreamCmdlet.PassThru"> <summary> Returns the collection of tag keys that were removed. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RemoveKINTagsFromStreamCmdlet.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.KIN.RequestKINStreamRetentionPeriodDecreaseCmdlet"> <summary> Decreases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream’s retention period is 24 hours. <para> This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RequestKINStreamRetentionPeriodDecreaseCmdlet.RetentionPeriodHour"> <summary> <para> <para>The new retention period of the stream, in hours. Must be less than the current retention period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RequestKINStreamRetentionPeriodDecreaseCmdlet.StreamName"> <summary> <para> <para>The name of the stream to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RequestKINStreamRetentionPeriodDecreaseCmdlet.PassThru"> <summary> Returns the value passed to the StreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RequestKINStreamRetentionPeriodDecreaseCmdlet.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.KIN.RequestKINStreamRetentionPeriodIncreaseCmdlet"> <summary> Increases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours (7 days). <para> Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream’s previous retention period) accessible after the operation has been called. For example, if a stream’s retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RequestKINStreamRetentionPeriodIncreaseCmdlet.RetentionPeriodHour"> <summary> <para> <para>The new retention period of the stream, in hours. Must be more than the current retention period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RequestKINStreamRetentionPeriodIncreaseCmdlet.StreamName"> <summary> <para> <para>The name of the stream to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RequestKINStreamRetentionPeriodIncreaseCmdlet.PassThru"> <summary> Returns the value passed to the StreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.RequestKINStreamRetentionPeriodIncreaseCmdlet.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.KIN.SplitKINShardCmdlet"> <summary> Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested. <para> You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing. </para><para> You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html">Split a Shard</a> in the <i>Amazon Kinesis Developer Guide</i>. </para><para> You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request. </para><para><code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Amazon Kinesis immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </para><para> You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>. </para><para> If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </para><para> For the default shard limit for an AWS account, see <a href="http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact AWS Support</a>. </para><para> If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a> or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </para><para><code>SplitShard</code> has limit of 5 transactions per second per account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.SplitKINShardCmdlet.NewStartingHashKey"> <summary> <para> <para>A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for <code>NewStartingHashKey</code> must be in the range of hash keys being mapped into the shard. The <code>NewStartingHashKey</code> hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.SplitKINShardCmdlet.ShardToSplit"> <summary> <para> <para>The shard ID of the shard to split.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.SplitKINShardCmdlet.StreamName"> <summary> <para> <para>The name of the stream for the shard split.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.SplitKINShardCmdlet.PassThru"> <summary> Returns the value passed to the StreamName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KIN.SplitKINShardCmdlet.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.LM.InvokeLMFunctionCmdlet"> <summary> Submits an invocation request to Lambda. Upon receiving the request, Lambda executes the specified cloud function. To see the logs generated by the cloud function execution, see the CloudWatch logs console. <para> This operation requires permission for the <code>lambda:Invoke</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionCmdlet.FunctionName"> <summary> <para> Gets and sets the property FunctionName. <para> The cloud function name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionCmdlet.Payload"> <summary> <para> Gets and sets the property InvokeArgs. <para> JSON that you want to provide to your Lambda function as input. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionCmdlet.ClientContext"> <summary> Using the <code>ClientContext</code> you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, go to <a href="http://docs.aws.amazon.com/mobileanalytics/latest/ug/PutEvents.html">PutEvents</a> in the <i>Amazon Mobile Analytics API Reference and User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionCmdlet.InvocationType"> <summary> By default, the <code>Invoke</code> API assumes "RequestResponse" invocation type. You can optionally request asynchronous execution by specifying "Event" as the <code>InvocationType</code>. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying "DryRun" as the <code>InvocationType</code>. This is useful in a cross-account scenario when you want to verify access to a function without running it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionCmdlet.LogType"> <summary> You can set this optional parameter to "Tail" in the request only if you specify the <code>InvocationType</code> parameter with value "RequestResponse". In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the <code>x-amz-log-results</code> header. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionCmdlet.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.LM.InvokeLMFunctionAsyncCmdlet"> <summary> Submits an invocation request to Lambda. Upon receiving the request, Lambda executes the specified cloud function asynchronously. To see the logs generated by the cloud function execution, see the CloudWatch logs console. <para> This operation requires permission for the <code>lambda:InvokeAsync</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionAsyncCmdlet.FunctionName"> <summary> <para> Gets and sets the property FunctionName. <para> The cloud function name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionAsyncCmdlet.InvokeArg"> <summary> <para> Gets and sets the property InvokeArgs. <para> JSON that you want to provide to your cloud function as input. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.InvokeLMFunctionAsyncCmdlet.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.LM.PublishLMFunctionCmdlet"> <summary> Creates a new Lambda function. If the function name already exists, the operation will fail. Note that the function name is case-sensitive. <para> This operation requires permission for the <code>lambda:CreateFunction</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.Description"> <summary> A short user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.FunctionName"> <summary> The name you want to assign to the function you are uploading. You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. The function names appear in the console and are returned in the <a>ListFunctions</a> API. Function names are used to specify functions to other AWS Lambda APIs, such as <a>Invoke</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.FunctionZip"> <summary> A file path to the zip file containing your packaged source code. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.Handler"> <summary> The function within your code that Lambda calls to begin execution. For Node.js, it is the <i>module-name</i>.<i>export</i> value in your function. For Java, it can be <code>package.class-name::handler</code> or <code>package.class-name</code>. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/java-programming-model-handler-types.html">Lambda Function Handler (Java)</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.MemorySize"> <summary> The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.Role"> <summary> The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.Runtime"> <summary> The runtime environment for the Lambda function you are uploading. Currently, Lambda supports "java" and "nodejs" as the runtime. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.Timeout"> <summary> The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMFunctionCmdlet.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.LM.AddLMPermissionCmdlet"> <summary> Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use "push" model. In "push" model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function. <para> For information about the push model, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a>. </para><para> If you are using versioning feature (see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html">AWS Lambda Function Versioning and Aliases</a>), a Lambda function can have multiple ARNs that can be used to invoke the function. Note that, each permission you add to resource policy using this API is specific to an ARN, specified using the <code>Qualifier</code> parameter </para><para> This operation requires permission for the <code>lambda:AddPermission</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.AddLMPermissionCmdlet.Action"> <summary> <para> <para>The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with "lambda:" followed by the API name (see <a>Operations</a>). For example, "lambda:CreateFunction". You can use wildcard ("lambda:*") to grant permission for all AWS Lambda actions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.AddLMPermissionCmdlet.FunctionName"> <summary> <para> <para>Name of the Lambda function whose resource policy you are updating by adding a new permission.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.AddLMPermissionCmdlet.Principal"> <summary> <para> <para>The principal who is getting this permission. It can be Amazon S3 service Principal ("s3.amazonaws.com") if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as "sns.amazonaws.com". For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.AddLMPermissionCmdlet.Qualifier"> <summary> <para> <para>You can specify this optional query parameter to specify function version or alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN: </para><para><code>arn:aws:lambda:aws-region:acct-id:function:function-name:2</code></para><para>If you specify alias name, for example "PROD", then the permission is valid only for requests made using the alias ARN:</para><para><code>arn:aws:lambda:aws-region:acct-id:function:function-name:PROD</code></para><para>If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN. </para><para><code>arn:aws:lambda:aws-region:acct-id:function:function-name</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.AddLMPermissionCmdlet.SourceAccount"> <summary> <para> <para>The AWS account ID (without a hyphen) of the source owner. For example, if the <code>SourceArn</code> identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the <code>SourceArn</code>) owned by a specific account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.AddLMPermissionCmdlet.SourceArn"> <summary> <para> <para>This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the bucket Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified bucket can invoke the function. </para><important>If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3.</important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.AddLMPermissionCmdlet.StatementId"> <summary> <para> <para>A unique statement identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.AddLMPermissionCmdlet.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.LM.GetLMAliasCmdlet"> <summary> Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html">Introduction to AWS Lambda Aliases</a><para> This requires permission for the lambda:GetAlias action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMAliasCmdlet.FunctionName"> <summary> <para> <para>Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function. So you must specify the function name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMAliasCmdlet.Name"> <summary> <para> <para>Name of the alias for which you want to retrieve information.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.GetLMAliasListCmdlet"> <summary> Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html">Introduction to AWS Lambda Aliases</a><para> This requires permission for the lambda:ListAliases action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMAliasListCmdlet.FunctionName"> <summary> <para> <para>Lambda function name for which the alias is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMAliasListCmdlet.FunctionVersion"> <summary> <para> <para>If you specify this optional parameter, the API returns only the aliases pointing to the specific Lambda function version, otherwise returns all aliases created for the Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMAliasListCmdlet.Marker"> <summary> <para> <para>Optional string. An opaque pagination token returned from a previous ListAliases operation. If present, indicates where to continue the listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMAliasListCmdlet.MaxItem"> <summary> <para> <para>Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.GetLMEventSourceMappingCmdlet"> <summary> Returns configuration information for the specified event source mapping (see <a>CreateEventSourceMapping</a>). <para> This operation requires permission for the <code>lambda:GetEventSourceMapping</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMEventSourceMappingCmdlet.UUID"> <summary> <para> <para>The AWS Lambda assigned ID of the event source mapping.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.GetLMEventSourceMappingsCmdlet"> <summary> Returns a list of event source mappings you created using the <code>CreateEventSourceMapping</code> (see <a>CreateEventSourceMapping</a>), where you identify a stream as an event source. This list does not include Amazon S3 event sources. <para> For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings. </para><para> This operation requires permission for the <code>lambda:ListEventSourceMappings</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMEventSourceMappingsCmdlet.EventSourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Kinesis stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMEventSourceMappingsCmdlet.FunctionName"> <summary> <para> <para>The name of the Lambda function.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMEventSourceMappingsCmdlet.Marker"> <summary> <para> <para>Optional string. An opaque pagination token returned from a previous <code>ListEventSourceMappings</code> operation. If present, specifies to continue the list from where the returning call left off. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMEventSourceMappingsCmdlet.MaxItem"> <summary> <para> <para>Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionCmdlet"> <summary> Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with <a>CreateFunction</a> so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function. <para> Using the optional <code>Qualifier</code> parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html">AWS Lambda Function Versioning and Aliases</a>. </para><para> This operation requires permission for the <code>lambda:GetFunction</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionCmdlet.FunctionName"> <summary> <para> <para>The Lambda function name. </para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionCmdlet.Qualifier"> <summary> <para> <para>Using this optional parameter to specify a function version or alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version. If you specify alias name, the API uses alias ARN and returns information about the function version to which the alias points. If you don't provide this parameter, the API uses unqualified function ARN and returns information about the $LATEST version of the Lambda function.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionConfigurationCmdlet"> <summary> Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using <a>CreateFunction</a>. <para> You can use the optional <code>Qualifier</code> parameter to retrieve configuration information for a specific Lambda function version. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html">AWS Lambda Function Versioning and Aliases</a>. </para><para> This operation requires permission for the <code>lambda:GetFunctionConfiguration</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionConfigurationCmdlet.FunctionName"> <summary> <para> <para>The name of the Lambda function for which you want to retrieve the configuration information.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionConfigurationCmdlet.Qualifier"> <summary> <para> <para>Using this optional parameter you can specify function version or alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. if you specify alias name, the API uses alias ARN and returns information about the function version to which the alias points.</para><para>If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionsCmdlet"> <summary> Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use <a>GetFunction</a> to retrieve the code for your function. <para> This operation requires permission for the <code>lambda:ListFunctions</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionsCmdlet.Marker"> <summary> <para> <para>Optional string. An opaque pagination token returned from a previous <code>ListFunctions</code> operation. If present, indicates where to continue the listing. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMFunctionsCmdlet.MaxItem"> <summary> <para> <para>Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.GetLMPolicyCmdlet"> <summary> Returns the resource policy, containing a list of permissions that apply to a specific to an ARN that you specify via the <code>Qualifier</code> paramter. <para> For informration about adding permissions, see <a>AddPermission</a>. </para><para> You need permission for the <code>lambda:GetPolicy action.</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMPolicyCmdlet.FunctionName"> <summary> <para> <para>Function name whose resource policy you want to retrieve. </para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMPolicyCmdlet.Qualifier"> <summary> <para> <para>You can specify this optional query parameter to specify function version or alias name in which case this API will return all permissions associated with the specific ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.GetLMVersionsByFunctionCmdlet"> <summary> List all versions of a function. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMVersionsByFunctionCmdlet.FunctionName"> <summary> <para> <para>Function name whose versions to list. You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMVersionsByFunctionCmdlet.Marker"> <summary> <para> <para> Optional string. An opaque pagination token returned from a previous <code>ListVersionsByFunction</code> operation. If present, indicates where to continue the listing. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.GetLMVersionsByFunctionCmdlet.MaxItem"> <summary> <para> <para> Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LM.NewLMAliasCmdlet"> <summary> Creates an alias to the specified Lambda function version. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html">Introduction to AWS Lambda Aliases</a><para> This requires permission for the lambda:CreateAlias action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMAliasCmdlet.Description"> <summary> <para> <para>Description of the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMAliasCmdlet.FunctionName"> <summary> <para> <para>Name of the Lambda function for which you want to create an alias. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMAliasCmdlet.FunctionVersion"> <summary> <para> <para>Lambda function version for which you are creating the alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMAliasCmdlet.Name"> <summary> <para> <para>Name for the alias your creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMAliasCmdlet.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.LM.NewLMEventSourceMappingCmdlet"> <summary> Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream. <para> This is the pull model, where AWS Lambda invokes the function. For more information, go to <a href="http://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html">AWS Lambda: How it Works</a> in the <i>AWS Lambda Developer Guide</i>. </para><para> This association between an Amazon Kinesis stream and a Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which Lambda function to invoke) for the event source mapping in the request body. </para><para> Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources. </para><para> This operation requires permission for the <code>lambda:CreateEventSourceMapping</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMEventSourceMappingCmdlet.BatchSize"> <summary> <para> <para>The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMEventSourceMappingCmdlet.Enabled"> <summary> <para> <para>Indicates whether AWS Lambda should begin polling the event source. By default, <code>Enabled</code> is true. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMEventSourceMappingCmdlet.EventSourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the <code>BatchSize</code>. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMEventSourceMappingCmdlet.FunctionName"> <summary> <para> <para>The Lambda function to invoke when AWS Lambda detects an event on the stream.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMEventSourceMappingCmdlet.StartingPosition"> <summary> <para> <para>The position in the stream where AWS Lambda should start reading. For more information, go to <a href="http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType">ShardIteratorType</a> in the <i>Amazon Kinesis API Reference</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.NewLMEventSourceMappingCmdlet.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.LM.PublishLMVersionCmdlet"> <summary> Publishes a version of your function from the current snapshot of HEAD. That is, AWS Lambda takes a snapshot of the function code and configuration information from HEAD and publishes a new version. The code and <code>handler</code> of this specific Lambda function version cannot be modified after publication, but you can modify the configuration information. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMVersionCmdlet.CodeSha256"> <summary> <para> <para>The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter value must match the SHA256 of the HEAD version for the publication to succeed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMVersionCmdlet.Description"> <summary> <para> <para> The description for the version you are publishing. If not provided, AWS Lambda copies the description from the HEAD version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMVersionCmdlet.FunctionName"> <summary> <para> <para>The Lambda function name. You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.PublishLMVersionCmdlet.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.LM.RemoveLMAliasCmdlet"> <summary> Deletes specified Lambda function alias. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html">Introduction to AWS Lambda Aliases</a><para> This requires permission for the lambda:DeleteAlias action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMAliasCmdlet.FunctionName"> <summary> <para> <para>The Lambda function name for which the alias is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMAliasCmdlet.Name"> <summary> <para> <para>Name of the alias to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMAliasCmdlet.PassThru"> <summary> Returns the value passed to the FunctionName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMAliasCmdlet.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.LM.RemoveLMEventSourceMappingCmdlet"> <summary> Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source. <para> This operation requires permission for the <code>lambda:DeleteEventSourceMapping</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMEventSourceMappingCmdlet.UUID"> <summary> <para> <para>The event source mapping ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMEventSourceMappingCmdlet.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.LM.RemoveLMFunctionCmdlet"> <summary> Deletes the specified Lambda function code and configuration. <para> If you don't specify a function version, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. </para><para> When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly. </para><para> For information about function versioning, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases-v2.html">AWS Lambda Function Versioning and Aliases</a>. </para><para> This operation requires permission for the <code>lambda:DeleteFunction</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMFunctionCmdlet.FunctionName"> <summary> <para> <para>The Lambda function to delete.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMFunctionCmdlet.Qualifier"> <summary> <para> <para>Using this optional parameter you can specify a function version (but not the $LATEST version) to direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version but not the $LATEST, that is, you cannot specify $LATEST as the value of this parameter. The $LATEST version can be deleted only when you want to delete all the function versions and aliases.</para><para>You can only specify a function version and not alias name using this parameter. You cannot delete a function version using its alias.</para><para>If you don't specify this parameter, AWS Lambda will delete the function, including all its versions and aliases.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMFunctionCmdlet.PassThru"> <summary> Returns the value passed to the FunctionName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMFunctionCmdlet.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.LM.RemoveLMPermissionCmdlet"> <summary> You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you addded the permission. The API removes corresponding permission that is associated with the specific ARN identified by the <code>Qualifier</code> parameter. <para> Note that removal of a permission will cause an active event source to lose permission to the function. </para><para> You need permission for the <code>lambda:RemovePermission</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMPermissionCmdlet.FunctionName"> <summary> <para> <para>Lambda function whose resource policy you want to remove a permission from.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMPermissionCmdlet.Qualifier"> <summary> <para> <para>You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMPermissionCmdlet.StatementId"> <summary> <para> <para>Statement ID of the permission to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMPermissionCmdlet.PassThru"> <summary> Returns the value passed to the FunctionName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.RemoveLMPermissionCmdlet.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.LM.UpdateLMAliasCmdlet"> <summary> Using this API you can update function version to which the alias points to and alias description. For more information, see <a href="http://docs.aws.amazon.com/lambda/latest/dg/versioning-v2-intro-aliases.html">Introduction to AWS Lambda Aliases</a><para> This requires permission for the lambda:UpdateAlias action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMAliasCmdlet.Description"> <summary> <para> <para>You can optionally change the description of the alias using this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMAliasCmdlet.FunctionName"> <summary> <para> <para>The function name for which the alias is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMAliasCmdlet.FunctionVersion"> <summary> <para> <para>Using this parameter you can optionally change the Lambda function version to which the alias to points to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMAliasCmdlet.Name"> <summary> <para> <para>The alias name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMAliasCmdlet.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.LM.UpdateLMEventSourceMappingCmdlet"> <summary> You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping. <para> This operation requires permission for the <code>lambda:UpdateEventSourceMapping</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMEventSourceMappingCmdlet.BatchSize"> <summary> <para> <para>The maximum number of stream records that can be sent to your Lambda function for a single invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMEventSourceMappingCmdlet.Enabled"> <summary> <para> <para>Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMEventSourceMappingCmdlet.FunctionName"> <summary> <para> <para>The Lambda function to which you want the stream records sent.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMEventSourceMappingCmdlet.UUID"> <summary> <para> <para>The event source mapping identifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMEventSourceMappingCmdlet.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.LM.UpdateLMFunctionCodeCmdlet"> <summary> Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration. <para> This operation requires permission for the <code>lambda:UpdateFunctionCode</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionCodeCmdlet.FunctionName"> <summary> <para> <para>The existing Lambda function name whose code you want to replace.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionCodeCmdlet.Publish"> <summary> <para> <para>This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionCodeCmdlet.S3Bucket"> <summary> <para> <para>Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionCodeCmdlet.S3Key"> <summary> <para> <para>The Amazon S3 object (the deployment package) key name you want to upload. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionCodeCmdlet.S3ObjectVersion"> <summary> <para> <para>The Amazon S3 object (the deployment package) version you want to upload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionCodeCmdlet.ZipFile"> <summary> <para> <para>Based64-encoded .zip file containing your packaged source code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionCodeCmdlet.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.LM.UpdateLMFunctionConfigurationCmdlet"> <summary> Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code. <para> This operation requires permission for the <code>lambda:UpdateFunctionConfiguration</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionConfigurationCmdlet.Description"> <summary> <para> <para>A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionConfigurationCmdlet.FunctionName"> <summary> <para> <para>The name of the Lambda function.</para><para> You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionConfigurationCmdlet.Handler"> <summary> <para> <para>The function that Lambda calls to begin executing your function. For Node.js, it is the <i>module-name.export</i> value in your function. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionConfigurationCmdlet.MemorySize"> <summary> <para> <para>The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionConfigurationCmdlet.Role"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionConfigurationCmdlet.Timeout"> <summary> <para> <para>The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LM.UpdateLMFunctionConfigurationCmdlet.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.ML.GetMLBatchPredictionCmdlet"> <summary> Returns a <code>BatchPrediction</code> that includes detailed metadata, status, and data file information for a <code>Batch Prediction</code> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionCmdlet.BatchPredictionId"> <summary> <para> <para>An ID assigned to the <code>BatchPrediction</code> at creation.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet"> <summary> Returns a list of <code>BatchPrediction</code> operations that match the search criteria in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.EQ"> <summary> <para> <para>The equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.FilterVariable"> <summary> <para> <para>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</para><ul><li><code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date.</li><li><code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status.</li><li><code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code><b></b><code>Name</code>.</li><li><code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation.</li><li><code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>.</li><li><code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>.</li><li><code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.GE"> <summary> <para> <para>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.GT"> <summary> <para> <para>The greater than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.LE"> <summary> <para> <para>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.LT"> <summary> <para> <para>The less than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.NE"> <summary> <para> <para>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.Prefix"> <summary> <para> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</para><para>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: </para><ul><li><para>2014-09</para></li><li><para>2014-09-09</para></li><li><para>2014-09-09-Holiday</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.SortOrder"> <summary> <para> <para>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</para><ul><li><code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</li><li><code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</li></ul><para>Results are sorted by <code>FilterVariable</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.Limit"> <summary> <para> <para>The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLBatchPredictionsCmdlet.NextToken"> <summary> <para> <para>An ID of the page in the paginated results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourceCmdlet"> <summary> Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>. <para><code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The ID assigned to the <code>DataSource</code> at creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourceCmdlet.VerboseResponse"> <summary> <para> <para>Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>.</para><para>If true, <code>DataSourceSchema</code> is returned.</para><para>If false, <code>DataSourceSchema</code> is not returned.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet"> <summary> Returns a list of <code>DataSource</code> that match the search criteria in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.EQ"> <summary> <para> <para>The equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.FilterVariable"> <summary> <para> <para>Use one of the following variables to filter a list of <code>DataSource</code>:</para><ul><li><code>CreatedAt</code> - Sets the search criteria to <code>DataSource</code> creation dates.</li><li><code>Status</code> - Sets the search criteria to <code>DataSource</code> statuses.</li><li><code>Name</code> - Sets the search criteria to the contents of <code>DataSource</code><b></b><code>Name</code>.</li><li><code>DataUri</code> - Sets the search criteria to the URI of data files used to create the <code>DataSource</code>. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.</li><li><code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>DataSource</code> creation.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.GE"> <summary> <para> <para>The greater than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.GT"> <summary> <para> <para>The greater than operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.LE"> <summary> <para> <para>The less than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.LT"> <summary> <para> <para>The less than operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.NE"> <summary> <para> <para>The not equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.Prefix"> <summary> <para> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</para><para>For example, a <code>DataSource</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>DataSource</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: </para><ul><li><para>2014-09</para></li><li><para>2014-09-09</para></li><li><para>2014-09-09-Holiday</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.SortOrder"> <summary> <para> <para>A two-value parameter that determines the sequence of the resulting list of <code>DataSource</code>.</para><ul><li><code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</li><li><code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</li></ul><para>Results are sorted by <code>FilterVariable</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.Limit"> <summary> <para> <para> The maximum number of <code>DataSource</code> to include in the result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLDataSourcesCmdlet.NextToken"> <summary> <para> <para>The ID of the page in the paginated results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationCmdlet"> <summary> Returns an <code>Evaluation</code> that includes metadata as well as the current status of the <code>Evaluation</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationCmdlet.EvaluationId"> <summary> <para> <para>The ID of the <code>Evaluation</code> to retrieve. The evaluation of each <code>MLModel</code> is recorded and cataloged. The ID provides the means to access the information. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet"> <summary> Returns a list of <code>DescribeEvaluations</code> that match the search criteria in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.EQ"> <summary> <para> <para>The equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.FilterVariable"> <summary> <para> <para>Use one of the following variable to filter a list of <code>Evaluation</code> objects:</para><ul><li><code>CreatedAt</code> - Sets the search criteria to the <code>Evaluation</code> creation date.</li><li><code>Status</code> - Sets the search criteria to the <code>Evaluation</code> status.</li><li><code>Name</code> - Sets the search criteria to the contents of <code>Evaluation</code><b></b><code>Name</code>.</li><li><code>IAMUser</code> - Sets the search criteria to the user account that invoked an <code>Evaluation</code>.</li><li><code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> that was evaluated.</li><li><code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in <code>Evaluation</code>.</li><li><code>DataUri</code> - Sets the search criteria to the data file(s) used in <code>Evaluation</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.GE"> <summary> <para> <para>The greater than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.GT"> <summary> <para> <para>The greater than operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.LE"> <summary> <para> <para>The less than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.LT"> <summary> <para> <para>The less than operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.NE"> <summary> <para> <para>The not equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.Prefix"> <summary> <para> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</para><para>For example, an <code>Evaluation</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>Evaluation</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: </para><ul><li><para>2014-09</para></li><li><para>2014-09-09</para></li><li><para>2014-09-09-Holiday</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.SortOrder"> <summary> <para> <para>A two-value parameter that determines the sequence of the resulting list of <code>Evaluation</code>.</para><ul><li><code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</li><li><code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</li></ul><para>Results are sorted by <code>FilterVariable</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.Limit"> <summary> <para> <para> The maximum number of <code>Evaluation</code> to include in the result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLEvaluationsCmdlet.NextToken"> <summary> <para> <para>The ID of the page in the paginated results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.GetMLModelCmdlet"> <summary> Returns an <code>MLModel</code> that includes detailed metadata, and data source information as well as the current status of the <code>MLModel</code>. <para><code>GetMLModel</code> provides results in normal or verbose format. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelCmdlet.MLModelId"> <summary> <para> <para>The ID assigned to the <code>MLModel</code> at creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelCmdlet.VerboseResponse"> <summary> <para> <para>Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>.</para><para>If true, <code>Recipe</code> is returned.</para><para>If false, <code>Recipe</code> is not returned.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet"> <summary> Returns a list of <code>MLModel</code> that match the search criteria in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.EQ"> <summary> <para> <para>The equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.FilterVariable"> <summary> <para> <para>Use one of the following variables to filter a list of <code>MLModel</code>:</para><ul><li><code>CreatedAt</code> - Sets the search criteria to <code>MLModel</code> creation date.</li><li><code>Status</code> - Sets the search criteria to <code>MLModel</code> status.</li><li><code>Name</code> - Sets the search criteria to the contents of <code>MLModel</code><b></b><code>Name</code>.</li><li><code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>MLModel</code> creation.</li><li><code>TrainingDataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used to train one or more <code>MLModel</code>.</li><li><code>RealtimeEndpointStatus</code> - Sets the search criteria to the <code>MLModel</code> real-time endpoint status.</li><li><code>MLModelType</code> - Sets the search criteria to <code>MLModel</code> type: binary, regression, or multi-class.</li><li><code>Algorithm</code> - Sets the search criteria to the algorithm that the <code>MLModel</code> uses.</li><li><code>TrainingDataURI</code> - Sets the search criteria to the data file(s) used in training a <code>MLModel</code>. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.GE"> <summary> <para> <para>The greater than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.GT"> <summary> <para> <para>The greater than operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.LE"> <summary> <para> <para>The less than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.LT"> <summary> <para> <para>The less than operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.NE"> <summary> <para> <para>The not equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.Prefix"> <summary> <para> <para>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</para><para>For example, an <code>MLModel</code> could have the <code>Name</code><code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>MLModel</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: </para><ul><li><para>2014-09</para></li><li><para>2014-09-09</para></li><li><para>2014-09-09-Holiday</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.SortOrder"> <summary> <para> <para>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>.</para><ul><li><code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</li><li><code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</li></ul><para>Results are sorted by <code>FilterVariable</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.Limit"> <summary> <para> <para>The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLModelsCmdlet.NextToken"> <summary> <para> <para>The ID of the page in the paginated results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.GetMLPredictionCmdlet"> <summary> Generates a prediction for the observation using the specified <code>ML Model</code>. <note><title>Note</title><para> Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLPredictionCmdlet.MLModelId"> <summary> <para> <para>A unique identifier of the <code>MLModel</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLPredictionCmdlet.PredictEndpoint"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.GetMLPredictionCmdlet.Record"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ML.NewMLBatchPredictionCmdlet"> <summary> Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a <code>DataSource</code>. This operation creates a new <code>BatchPrediction</code>, and uses an <code>MLModel</code> and the data files referenced by the <code>DataSource</code> as information sources. <para><code>CreateBatchPrediction</code> is an asynchronous operation. In response to <code>CreateBatchPrediction</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>BatchPrediction</code> status to <code>PENDING</code>. After the <code>BatchPrediction</code> completes, Amazon ML sets the status to <code>COMPLETED</code>. </para><para> You can poll for status updates by using the <a>GetBatchPrediction</a> operation and checking the <code>Status</code> parameter of the result. After the <code>COMPLETED</code> status appears, the results are available in the location specified by the <code>OutputUri</code> parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLBatchPredictionCmdlet.BatchPredictionDataSourceId"> <summary> <para> <para>The ID of the <code>DataSource</code> that points to the group of observations to predict.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLBatchPredictionCmdlet.BatchPredictionId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLBatchPredictionCmdlet.BatchPredictionName"> <summary> <para> <para>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLBatchPredictionCmdlet.MLModelId"> <summary> <para> <para>The ID of the <code>MLModel</code> that will generate predictions for the group of observations. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLBatchPredictionCmdlet.OutputUri"> <summary> <para> <para>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.</para><para>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="http://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLBatchPredictionCmdlet.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.ML.NewMLDataSourceFromRDSCmdlet"> <summary> Creates a <code>DataSource</code> object from an <a href="http://aws.amazon.com/rds/"> Amazon Relational Database Service</a> (Amazon RDS). A <code>DataSource</code> references data that can be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. <para><code>CreateDataSourceFromRDS</code> is an asynchronous operation. In response to <code>CreateDataSourceFromRDS</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. </para><para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.ComputeStatistic"> <summary> <para> <para>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during an <code>MLModel</code> training. This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.DatabaseInformation_DatabaseName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_DataRearrangement"> <summary> <para> <para>DataRearrangement - A JSON string that represents the splitting requirement of a <code>DataSource</code>. </para><para> Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_DataSchema"> <summary> <para> <para>A JSON string that represents the schema for an Amazon RDS <code>DataSource</code>. The <code>DataSchema</code> defines the structure of the observation data in the data file(s) referenced in the <code>DataSource</code>.</para><para>A <code>DataSchema</code> is not required if you specify a <code>DataSchemaUri</code></para><para>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code> and <code>excludedVariableNames</code> have an array of key-value pairs for their value. Use the following format to define your <code>DataSchema</code>.</para><para>{ "version": "1.0",</para><para> "recordAnnotationFieldName": "F1",</para><para> "recordWeightFieldName": "F2",</para><para> "targetFieldName": "F3",</para><para> "dataFormat": "CSV",</para><para> "dataFileContainsHeader": true,</para><para> "attributes": [</para><para> { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</para><para> "excludedVariableNames": [ "F6" ] } </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_DataSchemaUri"> <summary> <para> <para>The Amazon S3 location of the <code>DataSchema</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.DataSourceId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>DataSource</code>. Typically, an Amazon Resource Number (ARN) becomes the ID for a <code>DataSource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.DataSourceName"> <summary> <para> <para>A user-supplied name or description of the <code>DataSource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.DatabaseInformation_InstanceIdentifier"> <summary> <para> <para>The ID of an RDS DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.DatabaseCredentials_Password"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_ResourceRole"> <summary> <para> <para>The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RoleARN"> <summary> <para> <para>The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user’s account and copy data (using the <code>SelectSqlQuery</code>) query from Amazon RDS to Amazon S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_S3StagingLocation"> <summary> <para> <para>The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using <code>SelectSqlQuery</code> is stored in this location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_SecurityGroupId"> <summary> <para> <para>The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_SelectSqlQuery"> <summary> <para> <para>The query that is used to retrieve the observation data for the <code>DataSource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_ServiceRole"> <summary> <para> <para>The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.RDSData_SubnetId"> <summary> <para> <para>The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.DatabaseCredentials_Username"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRDSCmdlet.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.ML.NewMLDataSourceFromRedshiftCmdlet"> <summary> Creates a <code>DataSource</code> from <a href="http://aws.amazon.com/redshift/">Amazon Redshift</a>. A <code>DataSource</code> references data that can be used to perform either <a>CreateMLModel</a>, <a>CreateEvaluation</a> or <a>CreateBatchPrediction</a> operations. <para><code>CreateDataSourceFromRedshift</code> is an asynchronous operation. In response to <code>CreateDataSourceFromRedshift</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. </para><para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para><para> The observations should exist in the database hosted on an Amazon Redshift cluster and should be specified by a <code>SelectSqlQuery</code>. Amazon ML executes <a href="http://docs.aws.amazon.com/redshift/latest/dg/t_Unloading_tables.html"> Unload</a> command in Amazon Redshift to transfer the result set of <code>SelectSqlQuery</code> to <code>S3StagingLocation.</code></para><para> After the <code>DataSource</code> is created, it's ready for use in evaluations and batch predictions. If you plan to use the <code>DataSource</code> to train an <code>MLModel</code>, the <code>DataSource</code> requires another item -- a recipe. A recipe describes the observation variables that participate in training an <code>MLModel</code>. A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable or split apart into word combinations? The recipe provides answers to these questions. For more information, see the Amazon Machine Learning Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DatabaseInformation_ClusterIdentifier"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.ComputeStatistic"> <summary> <para> <para>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training. This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DatabaseInformation_DatabaseName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DataSpec_DataRearrangement"> <summary> <para> <para>Describes the splitting specifications for a <code>DataSource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DataSpec_DataSchema"> <summary> <para> <para>A JSON string that represents the schema for an Amazon Redshift <code>DataSource</code>. The <code>DataSchema</code> defines the structure of the observation data in the data file(s) referenced in the <code>DataSource</code>.</para><para>A <code>DataSchema</code> is not required if you specify a <code>DataSchemaUri</code>.</para><para>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code> and <code>excludedVariableNames</code> have an array of key-value pairs for their value. Use the following format to define your <code>DataSchema</code>.</para><para>{ "version": "1.0",</para><para> "recordAnnotationFieldName": "F1",</para><para> "recordWeightFieldName": "F2",</para><para> "targetFieldName": "F3",</para><para> "dataFormat": "CSV",</para><para> "dataFileContainsHeader": true,</para><para> "attributes": [</para><para> { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</para><para> "excludedVariableNames": [ "F6" ] } </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DataSpec_DataSchemaUri"> <summary> <para> <para>Describes the schema location for an Amazon Redshift <code>DataSource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DataSourceId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DataSourceName"> <summary> <para> <para>A user-supplied name or description of the <code>DataSource</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DatabaseCredentials_Password"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.RoleARN"> <summary> <para> <para>A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following: </para><para><ul><li><para>A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon Redshift cluster</para></li><li><para>An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the <code>S3StagingLocation</code></para></li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DataSpec_S3StagingLocation"> <summary> <para> <para>Describes an Amazon S3 location to store the result set of the <code>SelectSqlQuery</code> query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DataSpec_SelectSqlQuery"> <summary> <para> <para>Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift <code>DataSource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.DatabaseCredentials_Username"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromRedshiftCmdlet.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.ML.NewMLDataSourceFromS3Cmdlet"> <summary> Creates a <code>DataSource</code> object. A <code>DataSource</code> references data that can be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a>, or <a>CreateBatchPrediction</a> operations. <para><code>CreateDataSourceFromS3</code> is an asynchronous operation. In response to <code>CreateDataSourceFromS3</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>DataSource</code> status to <code>PENDING</code>. After the <code>DataSource</code> is created and ready for use, Amazon ML sets the <code>Status</code> parameter to <code>COMPLETED</code>. <code>DataSource</code> in <code>COMPLETED</code> or <code>PENDING</code> status can only be used to perform <a>CreateMLModel</a>, <a>CreateEvaluation</a> or <a>CreateBatchPrediction</a> operations. </para><para> If Amazon ML cannot accept the input source, it sets the <code>Status</code> parameter to <code>FAILED</code> and includes an error message in the <code>Message</code> attribute of the <a>GetDataSource</a> operation response. </para><para> The observation data used in a <code>DataSource</code> should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more CSV files in an Amazon Simple Storage Service (Amazon S3) bucket, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the <code>DataSource</code>. </para><para> After the <code>DataSource</code> has been created, it's ready to use in evaluations and batch predictions. If you plan to use the <code>DataSource</code> to train an <code>MLModel</code>, the <code>DataSource</code> requires another item: a recipe. A recipe describes the observation variables that participate in training an <code>MLModel</code>. A recipe describes how each input variable will be used in training. Will the variable be included or excluded from training? Will the variable be manipulated, for example, combined with another variable, or split apart into word combinations? The recipe provides answers to these questions. For more information, see the <a href="http://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromS3Cmdlet.ComputeStatistic"> <summary> <para> <para>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during an <code>MLModel</code> training. This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromS3Cmdlet.DataSpec_DataLocationS3"> <summary> <para> <para>The location of the data file(s) used by a <code>DataSource</code>. The URI specifies a data file or an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromS3Cmdlet.DataSpec_DataRearrangement"> <summary> <para> <para> Describes the splitting requirement of a <code>Datasource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromS3Cmdlet.DataSpec_DataSchema"> <summary> <para> <para> A JSON string that represents the schema for an Amazon S3 <code>DataSource</code>. The <code>DataSchema</code> defines the structure of the observation data in the data file(s) referenced in the <code>DataSource</code>.</para><para>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code> and <code>excludedVariableNames</code> have an array of key-value pairs for their value. Use the following format to define your <code>DataSchema</code>.</para><para>{ "version": "1.0",</para><para> "recordAnnotationFieldName": "F1",</para><para> "recordWeightFieldName": "F2",</para><para> "targetFieldName": "F3",</para><para> "dataFormat": "CSV",</para><para> "dataFileContainsHeader": true,</para><para> "attributes": [</para><para> { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</para><para> "excludedVariableNames": [ "F6" ] } </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromS3Cmdlet.DataSpec_DataSchemaLocationS3"> <summary> <para> <para>Describes the schema Location in Amazon S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromS3Cmdlet.DataSourceId"> <summary> <para> <para>A user-supplied identifier that uniquely identifies the <code>DataSource</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromS3Cmdlet.DataSourceName"> <summary> <para> <para>A user-supplied name or description of the <code>DataSource</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLDataSourceFromS3Cmdlet.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.ML.NewMLEvaluationCmdlet"> <summary> Creates a new <code>Evaluation</code> of an <code>MLModel</code>. An <code>MLModel</code> is evaluated on a set of observations associated to a <code>DataSource</code>. Like a <code>DataSource</code> for an <code>MLModel</code>, the <code>DataSource</code> for an <code>Evaluation</code> contains values for the Target Variable. The <code>Evaluation</code> compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the <code>MLModel</code> functions on the test data. Evaluation generates a relevant performance metric such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding <code>MLModelType</code>: <code>BINARY</code>, <code>REGRESSION</code> or <code>MULTICLASS</code>. <para><code>CreateEvaluation</code> is an asynchronous operation. In response to <code>CreateEvaluation</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to <code>PENDING</code>. After the <code>Evaluation</code> is created and ready for use, Amazon ML sets the status to <code>COMPLETED</code>. </para><para> You can use the <a>GetEvaluation</a> operation to check progress of the evaluation during the creation operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLEvaluationCmdlet.EvaluationDataSourceId"> <summary> <para> <para>The ID of the <code>DataSource</code> for the evaluation. The schema of the <code>DataSource</code> must match the schema used to create the <code>MLModel</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLEvaluationCmdlet.EvaluationId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>Evaluation</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLEvaluationCmdlet.EvaluationName"> <summary> <para> <para>A user-supplied name or description of the <code>Evaluation</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLEvaluationCmdlet.MLModelId"> <summary> <para> <para>The ID of the <code>MLModel</code> to evaluate.</para><para>The schema used in creating the <code>MLModel</code> must match the schema of the <code>DataSource</code> used in the <code>Evaluation</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLEvaluationCmdlet.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.ML.NewMLModelCmdlet"> <summary> Creates a new <code>MLModel</code> using the data files and the recipe as information sources. <para> An <code>MLModel</code> is nearly immutable. Users can only update the <code>MLModelName</code> and the <code>ScoreThreshold</code> in an <code>MLModel</code> without creating a new <code>MLModel</code>. </para><para><code>CreateMLModel</code> is an asynchronous operation. In response to <code>CreateMLModel</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>MLModel</code> status to <code>PENDING</code>. After the <code>MLModel</code> is created and ready for use, Amazon ML sets the status to <code>COMPLETED</code>. </para><para> You can use the <a>GetMLModel</a> operation to check progress of the <code>MLModel</code> during the creation operation. </para><para><a>CreateMLModel</a> requires a <code>DataSource</code> with computed statistics, which can be created by setting <code>ComputeStatistics</code> to <code>true</code> in <a>CreateDataSourceFromRDS</a>, <a>CreateDataSourceFromS3</a>, or <a>CreateDataSourceFromRedshift</a> operations. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLModelCmdlet.MLModelId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLModelCmdlet.MLModelName"> <summary> <para> <para>A user-supplied name or description of the <code>MLModel</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLModelCmdlet.MLModelType"> <summary> <para> <para>The category of supervised learning that this <code>MLModel</code> will address. Choose from the following types:</para><ul><li>Choose <code>REGRESSION</code> if the <code>MLModel</code> will be used to predict a numeric value.</li><li>Choose <code>BINARY</code> if the <code>MLModel</code> result has two possible values.</li><li>Choose <code>MULTICLASS</code> if the <code>MLModel</code> result has a limited number of values. </li></ul><para> For more information, see the <a href="http://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLModelCmdlet.Parameter"> <summary> <para> <para>A list of the training parameters in the <code>MLModel</code>. The list is implemented as a map of key/value pairs.</para><para>The following is the current set of training parameters: </para><ul><li><para><code>sgd.l1RegularizationAmount</code> - Coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value such as 1.0E-08.</para><para>The value is a double that ranges from 0 to MAX_DOUBLE. The default is not to use L1 normalization. The parameter cannot be used when <code>L2</code> is specified. Use this parameter sparingly.</para></li><li><para><code>sgd.l2RegularizationAmount</code> - Coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value such as 1.0E-08.</para><para>The valuseis a double that ranges from 0 to MAX_DOUBLE. The default is not to use L2 normalization. This cannot be used when <code>L1</code> is specified. Use this parameter sparingly.</para></li><li><para><code>sgd.maxPasses</code> - Number of times that the training process traverses the observations to build the <code>MLModel</code>. The value is an integer that ranges from 1 to 10000. The default value is 10. </para></li><li><para><code>sgd.maxMLModelSizeInBytes</code> - Maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.</para><para> The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLModelCmdlet.Recipe"> <summary> <para> <para>The data recipe for creating <code>MLModel</code>. You must specify either the recipe or its URI. If you don’t specify a recipe or its URI, Amazon ML creates a default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLModelCmdlet.RecipeUri"> <summary> <para> <para>The Amazon Simple Storage Service (Amazon S3) location and file name that contains the <code>MLModel</code> recipe. You must specify either the recipe or its URI. If you don’t specify a recipe or its URI, Amazon ML creates a default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLModelCmdlet.TrainingDataSourceId"> <summary> <para> <para>The <code>DataSource</code> that points to the training data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLModelCmdlet.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.ML.NewMLRealtimeEndpointCmdlet"> <summary> Creates a real-time endpoint for the <code>MLModel</code>. The endpoint contains the URI of the <code>MLModel</code>; that is, the location to send real-time prediction requests for the specified <code>MLModel</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLRealtimeEndpointCmdlet.MLModelId"> <summary> <para> <para>The ID assigned to the <code>MLModel</code> during creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.NewMLRealtimeEndpointCmdlet.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.ML.RemoveMLBatchPredictionCmdlet"> <summary> Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable. <para> After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a> operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED. </para><para><b>Caution:</b> The result of the <code>DeleteBatchPrediction</code> operation is irreversible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLBatchPredictionCmdlet.BatchPredictionId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLBatchPredictionCmdlet.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.ML.RemoveMLDataSourceCmdlet"> <summary> Assigns the DELETED status to a <code>DataSource</code>, rendering it unusable. <para> After using the <code>DeleteDataSource</code> operation, you can use the <a>GetDataSource</a> operation to verify that the status of the <code>DataSource</code> changed to DELETED. </para><para><b>Caution:</b> The results of the <code>DeleteDataSource</code> operation are irreversible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLDataSourceCmdlet.DataSourceId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLDataSourceCmdlet.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.ML.RemoveMLEvaluationCmdlet"> <summary> Assigns the <code>DELETED</code> status to an <code>Evaluation</code>, rendering it unusable. <para> After invoking the <code>DeleteEvaluation</code> operation, you can use the <a>GetEvaluation</a> operation to verify that the status of the <code>Evaluation</code> changed to <code>DELETED</code>. </para><para><b>Caution:</b> The results of the <code>DeleteEvaluation</code> operation are irreversible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLEvaluationCmdlet.EvaluationId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>Evaluation</code> to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLEvaluationCmdlet.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.ML.RemoveMLModelCmdlet"> <summary> Assigns the DELETED status to an <code>MLModel</code>, rendering it unusable. <para> After using the <code>DeleteMLModel</code> operation, you can use the <a>GetMLModel</a> operation to verify that the status of the <code>MLModel</code> changed to DELETED. </para><para><b>Caution:</b> The result of the <code>DeleteMLModel</code> operation is irreversible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLModelCmdlet.MLModelId"> <summary> <para> <para>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLModelCmdlet.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.ML.RemoveMLRealtimeEndpointCmdlet"> <summary> Deletes a real time endpoint of an <code>MLModel</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLRealtimeEndpointCmdlet.MLModelId"> <summary> <para> <para>The ID assigned to the <code>MLModel</code> during creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.RemoveMLRealtimeEndpointCmdlet.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.ML.UpdateMLBatchPredictionCmdlet"> <summary> Updates the <code>BatchPredictionName</code> of a <code>BatchPrediction</code>. <para> You can use the <a>GetBatchPrediction</a> operation to view the contents of the updated data element. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLBatchPredictionCmdlet.BatchPredictionId"> <summary> <para> <para>The ID assigned to the <code>BatchPrediction</code> during creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLBatchPredictionCmdlet.BatchPredictionName"> <summary> <para> <para>A new user-supplied name or description of the <code>BatchPrediction</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLBatchPredictionCmdlet.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.ML.UpdateMLDataSourceCmdlet"> <summary> Updates the <code>DataSourceName</code> of a <code>DataSource</code>. <para> You can use the <a>GetDataSource</a> operation to view the contents of the updated data element. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The ID assigned to the <code>DataSource</code> during creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLDataSourceCmdlet.DataSourceName"> <summary> <para> <para>A new user-supplied name or description of the <code>DataSource</code> that will replace the current description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLDataSourceCmdlet.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.ML.UpdateMLEvaluationCmdlet"> <summary> Updates the <code>EvaluationName</code> of an <code>Evaluation</code>. <para> You can use the <a>GetEvaluation</a> operation to view the contents of the updated data element. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLEvaluationCmdlet.EvaluationId"> <summary> <para> <para>The ID assigned to the <code>Evaluation</code> during creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLEvaluationCmdlet.EvaluationName"> <summary> <para> <para>A new user-supplied name or description of the <code>Evaluation</code> that will replace the current content. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLEvaluationCmdlet.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.ML.UpdateMLMLModelCmdlet"> <summary> Updates the <code>MLModelName</code> and the <code>ScoreThreshold</code> of an <code>MLModel</code>. <para> You can use the <a>GetMLModel</a> operation to view the contents of the updated data element. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLMLModelCmdlet.MLModelId"> <summary> <para> <para>The ID assigned to the <code>MLModel</code> during creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLMLModelCmdlet.MLModelName"> <summary> <para> <para>A user-supplied name or description of the <code>MLModel</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLMLModelCmdlet.ScoreThreshold"> <summary> <para> <para>The <code>ScoreThreshold</code> used in binary classification <code>MLModel</code> that marks the boundary between a positive prediction and a negative prediction.</para><para>Output values greater than or equal to the <code>ScoreThreshold</code> receive a positive result from the <code>MLModel</code>, such as <code>true</code>. Output values less than the <code>ScoreThreshold</code> receive a negative response from the <code>MLModel</code>, such as <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ML.UpdateMLMLModelCmdlet.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.OPS.AddOPSElasticIpCmdlet"> <summary> Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling <a>RegisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticIpCmdlet.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.OPS.AddOPSElasticLoadBalancerCmdlet"> <summary> Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/load-balancer-elb.html">Elastic Load Balancing</a>. <note><para> You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html"> Elastic Load Balancing Developer Guide</a>. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticLoadBalancerCmdlet.ElasticLoadBalancerName"> <summary> <para> <para>The Elastic Load Balancing instance's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticLoadBalancerCmdlet.LayerId"> <summary> <para> <para>The ID of the layer that the Elastic Load Balancing instance is to be attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticLoadBalancerCmdlet.PassThru"> <summary> Returns the value passed to the ElasticLoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSElasticLoadBalancerCmdlet.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.OPS.AddOPSVolumeCmdlet"> <summary> Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling <a>RegisterVolume</a>. After you register the volume, you must call <a>UpdateVolume</a> to specify a mount point before calling <code>AssignVolume</code>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSVolumeCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>The volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSVolumeCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.AddOPSVolumeCmdlet.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.OPS.CopyOPSStackCmdlet"> <summary> Creates a clone of a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html">Clone a Stack</a>. By default, all parameters are set to the values used by the parent stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks agent version. You have the following options:</para><ul><li>Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.</li><li>Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.</li></ul><para>The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>.</para><note>You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.Attribute"> <summary> <para> <para>A list of stack attributes and values as key/value pairs to be added to the cloned stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ChefConfiguration_BerkshelfVersion"> <summary> <para> <para>The Berkshelf version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CloneAppId"> <summary> <para> <para>A list of source stack app IDs to be included in the cloned stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ClonePermission"> <summary> <para> <para>Whether to clone the source stack's permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomJson"> <summary> <para> <para>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"':</para><para><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></para><para>For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultAvailabilityZone"> <summary> <para> <para>The cloned stack's default Availability Zone, which must be in the specified region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultInstanceProfileArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultOs"> <summary> <para> <para>The stack's operating system, which must be set to one of the following.</para><ul><li>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2015.03</code>, <code>Red Hat Enterprise Linux 7</code>, <code>Ubuntu 12.04 LTS</code>, or <code>Ubuntu 14.04 LTS</code>.</li><li><code>Microsoft Windows Server 2012 R2 Base</code>.</li><li>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</li></ul><para>The default option is the parent stack's operating system. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Operating Systems</a>.</para><note>You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultRootDeviceType"> <summary> <para> <para>The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultSshKeyName"> <summary> <para> <para>A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.DefaultSubnetId"> <summary> <para> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.HostnameTheme"> <summary> <para> <para>The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are:</para><ul><li><code>Baked_Goods</code></li><li><code>Clouds</code></li><li><code>Europe_Cities</code></li><li><code>Fruits</code></li><li><code>Greek_Deities</code></li><li><code>Legendary_creatures_from_Japan</code></li><li><code>Planets_and_Moons</code></li><li><code>Roman_Deities</code></li><li><code>Scottish_Islands</code></li><li><code>US_Cities</code></li><li><code>Wild_Cats</code></li></ul><para>To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ChefConfiguration_ManageBerkshelf"> <summary> <para> <para>Whether to enable Berkshelf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ConfigurationManager_Name"> <summary> <para> <para>The name. This parameter must be set to "Chef".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.Name"> <summary> <para> <para>The cloned stack name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</li><li>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</li></ul><para>For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"></a>.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.StackRegion"> <summary> <para> <para>The cloned stack AWS region, such as "us-east-1". For more information about AWS regions, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ServiceRoleArn"> <summary> <para> <para>The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling <a>DescribePermissions</a>. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para><note><para>You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.SourceStackId"> <summary> <para> <para>The source stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Url"> <summary> <para> <para>The source URL. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.UseCustomCookbook"> <summary> <para> <para>Whether to use custom cookbooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.UseOpsworksSecurityGroup"> <summary> <para> <para>Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.</para><para>AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With <code>UseOpsworksSecurityGroups</code> you can instead provide your own custom security groups. <code>UseOpsworksSecurityGroups</code> has the following settings: </para><ul><li>True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group. </li><li>False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. </li></ul><para>For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.CustomCookbooksSource_Username"> <summary> <para> <para>This parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</li><li>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.ConfigurationManager_Version"> <summary> <para> <para>The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.</para><ul><li>If your account supports EC2 Classic, the default value is no VPC.</li><li>If your account does not support EC2 Classic, the default value is the default VPC for the specified region.</li></ul><para>If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. </para><para>If you specify a nondefault VPC ID, note the following:</para><ul><li>It must belong to a VPC in your account that is in the specified region.</li><li>You must specify a value for <code>DefaultSubnetId</code>.</li></ul><para>For more information on how to use AWS OpsWorks with a VPC, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html">Running a Stack in a VPC</a>. For more information on default VPC and EC2 Classic, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.CopyOPSStackCmdlet.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.OPS.DismountOPSElasticLoadBalancerCmdlet"> <summary> Detaches a specified Elastic Load Balancing instance from its layer. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.DismountOPSElasticLoadBalancerCmdlet.ElasticLoadBalancerName"> <summary> <para> <para>The Elastic Load Balancing instance's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.DismountOPSElasticLoadBalancerCmdlet.LayerId"> <summary> <para> <para>The ID of the layer that the Elastic Load Balancing instance is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.DismountOPSElasticLoadBalancerCmdlet.PassThru"> <summary> Returns the value passed to the ElasticLoadBalancerName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.DismountOPSElasticLoadBalancerCmdlet.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.OPS.GetOPSAgentVersionCmdlet"> <summary> Describes the available AWS OpsWorks agent versions. You must specify a stack ID or a configuration manager. <code>DescribeAgentVersions</code> returns a list of available agent versions for the specified stack or configuration manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAgentVersionCmdlet.ConfigurationManager_Name"> <summary> <para> <para>The name. This parameter must be set to "Chef".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAgentVersionCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAgentVersionCmdlet.ConfigurationManager_Version"> <summary> <para> <para>The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSAppsCmdlet"> <summary> Requests a description of a specified set of apps. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAppsCmdlet.AppId"> <summary> <para> <para>An array of app IDs for the apps to be described. If you use this parameter, <code>DescribeApps</code> returns a description of the specified apps. Otherwise, it returns a description of every app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSAppsCmdlet.StackId"> <summary> <para> <para>The app stack ID. If you use this parameter, <code>DescribeApps</code> returns a description of the apps in the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSCommandsCmdlet"> <summary> Describes the results of specified commands. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSCommandsCmdlet.CommandId"> <summary> <para> <para>An array of command IDs. If you include this parameter, <code>DescribeCommands</code> returns a description of the specified commands. Otherwise, it returns a description of every command.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSCommandsCmdlet.DeploymentId"> <summary> <para> <para>The deployment ID. If you include this parameter, <code>DescribeCommands</code> returns a description of the commands associated with the specified deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSCommandsCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you include this parameter, <code>DescribeCommands</code> returns a description of the commands associated with the specified instance.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSDeploymentsCmdlet"> <summary> Requests a description of a specified set of deployments. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSDeploymentsCmdlet.AppId"> <summary> <para> <para>The app ID. If you include this parameter, <code>DescribeDeployments</code> returns a description of the commands associated with the specified app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSDeploymentsCmdlet.DeploymentId"> <summary> <para> <para>An array of deployment IDs to be described. If you include this parameter, <code>DescribeDeployments</code> returns a description of the specified deployments. Otherwise, it returns a description of every deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSDeploymentsCmdlet.StackId"> <summary> <para> <para>The stack ID. If you include this parameter, <code>DescribeDeployments</code> returns a description of the commands associated with the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSEcsClusterCmdlet"> <summary> Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and <code>NextToken</code> parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSEcsClusterCmdlet.EcsClusterArn"> <summary> <para> <para>A list of ARNs, one for each cluster to be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSEcsClusterCmdlet.StackId"> <summary> <para> <para>A stack ID. <code>DescribeEcsClusters</code> returns a description of the cluster that is registered with the stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSEcsClusterCmdlet.MaxResult"> <summary> <para> <para>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSEcsClusterCmdlet.NextToken"> <summary> <para> <para>If the previous paginated request did not return all of the remaining results, the response object's<code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>DescribeEcsClusters</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticIpsCmdlet"> <summary> Describes <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP addresses</a>. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticIpsCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the Elastic IP addresses associated with the specified instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticIpsCmdlet.Ip"> <summary> <para> <para>An array of Elastic IP addresses to be described. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticIpsCmdlet.StackId"> <summary> <para> <para>A stack ID. If you include this parameter, <code>DescribeElasticIps</code> returns a description of the Elastic IP addresses that are registered with the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticLoadBalancersCmdlet"> <summary> Describes a stack's Elastic Load Balancing instances. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticLoadBalancersCmdlet.LayerId"> <summary> <para> <para>A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSElasticLoadBalancersCmdlet.StackId"> <summary> <para> <para>A stack ID. The action describes the stack's Elastic Load Balancing instances.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSHostnameSuggestionCmdlet"> <summary> Gets a generated host name for the specified layer, based on the current host name theme. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSHostnameSuggestionCmdlet.LayerId"> <summary> <para> <para>The layer ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSInstancesCmdlet"> <summary> Requests a description of a set of instances. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSInstancesCmdlet.InstanceId"> <summary> <para> <para>An array of instance IDs to be described. If you use this parameter, <code>DescribeInstances</code> returns a description of the specified instances. Otherwise, it returns a description of every instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSInstancesCmdlet.LayerId"> <summary> <para> <para>A layer ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSInstancesCmdlet.StackId"> <summary> <para> <para>A stack ID. If you use this parameter, <code>DescribeInstances</code> returns descriptions of the instances associated with the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSLayersCmdlet"> <summary> Requests a description of one or more layers in a specified stack. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSLayersCmdlet.LayerId"> <summary> <para> <para>An array of layer IDs that specify the layers to be described. If you omit this parameter, <code>DescribeLayers</code> returns a description of every layer in the specified stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSLayersCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSLoadBasedAutoScalingCmdlet"> <summary> Describes load-based auto scaling configurations for specified layers. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSLoadBasedAutoScalingCmdlet.LayerId"> <summary> <para> <para>An array of layer IDs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSMyUserProfileCmdlet"> <summary> Describes a user's SSH information. <para><b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSPermissionsCmdlet"> <summary> Describes the permissions for a specified stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSPermissionsCmdlet.IamUserArn"> <summary> <para> <para>The user's IAM ARN. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSPermissionsCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSRaidArraysCmdlet"> <summary> Describe an instance's RAID arrays. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRaidArraysCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you use this parameter, <code>DescribeRaidArrays</code> returns descriptions of the RAID arrays associated with the specified instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRaidArraysCmdlet.RaidArrayId"> <summary> <para> <para>An array of RAID array IDs. If you use this parameter, <code>DescribeRaidArrays</code> returns descriptions of the specified arrays. Otherwise, it returns a description of every array.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRaidArraysCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSRdsDbInstancesCmdlet"> <summary> Describes Amazon RDS instances. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRdsDbInstancesCmdlet.RdsDbInstanceArn"> <summary> <para> <para>An array containing the ARNs of the instances to be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSRdsDbInstancesCmdlet.StackId"> <summary> <para> <para>The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSServiceErrorsCmdlet"> <summary> Describes AWS OpsWorks service errors. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSServiceErrorsCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the errors associated with the specified instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSServiceErrorsCmdlet.ServiceErrorId"> <summary> <para> <para>An array of service error IDs. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the specified errors. Otherwise, it returns a description of every error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSServiceErrorsCmdlet.StackId"> <summary> <para> <para>The stack ID. If you use this parameter, <code>DescribeServiceErrors</code> returns descriptions of the errors associated with the specified stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackProvisioningParametersCmdlet"> <summary> Requests a description of a stack's provisioning parameters. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackProvisioningParametersCmdlet.StackId"> <summary> <para> <para>The stack ID</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSStacksCmdlet"> <summary> Requests a description of one or more stacks. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSStacksCmdlet.StackId"> <summary> <para> <para>An array of stack IDs that specify the stacks to be described. If you omit this parameter, <code>DescribeStacks</code> returns a description of every stack.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackSummaryCmdlet"> <summary> Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or <code>online</code>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSStackSummaryCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSTimeBasedAutoScalingCmdlet"> <summary> Describes time-based auto scaling configurations for specified instances. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSTimeBasedAutoScalingCmdlet.InstanceId"> <summary> <para> <para>An array of instance IDs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSUserProfilesCmdlet"> <summary> Describe specified users. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSUserProfilesCmdlet.IamUserArn"> <summary> <para> <para>An array of IAM user ARNs that identify the users to be described. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumesCmdlet"> <summary> Describes an instance's Amazon EBS volumes. <note><para> You must specify at least one of the parameters. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumesCmdlet.InstanceId"> <summary> <para> <para>The instance ID. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the volumes associated with the specified instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumesCmdlet.RaidArrayId"> <summary> <para> <para>The RAID array ID. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the volumes associated with the specified RAID array.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumesCmdlet.StackId"> <summary> <para> <para>A stack ID. The action describes the stack's registered Amazon EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GetOPSVolumesCmdlet.VolumeId"> <summary> <para> <para>Am array of volume IDs. If you use this parameter, <code>DescribeVolumes</code> returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OPS.GrantOPSAccessCmdlet"> <summary> <note>This action can be used only with Windows stacks.</note><para> Grants RDP access to a Windows instance for a specified time period. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GrantOPSAccessCmdlet.InstanceId"> <summary> <para> <para>The instance's AWS OpsWorks ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GrantOPSAccessCmdlet.ValidForInMinute"> <summary> <para> <para>The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.GrantOPSAccessCmdlet.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.OPS.NewOPSAppCmdlet"> <summary> Creates an app for a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html">Creating Apps</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key/value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.SslConfiguration_Certificate"> <summary> <para> <para>The contents of the certificate's domain.crt file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.SslConfiguration_Chain"> <summary> <para> <para>Optional. Can be used to specify an intermediate certificate authority key or client authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.DataSource"> <summary> <para> <para>The app's data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Description"> <summary> <para> <para>A description of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Domain"> <summary> <para> <para>The app virtual host settings, with multiple domains separated by commas. For example: <code>'www.example.com, example.com'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.EnableSsl"> <summary> <para> <para>Whether to enable SSL for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Environment"> <summary> <para> <para>An array of <code>EnvironmentVariable</code> objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment"> Environment Variables</a>.</para><para> There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)." </para><note>This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Name"> <summary> <para> <para>The app name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</li><li>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</li></ul><para>For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"></a>.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.SslConfiguration_PrivateKey"> <summary> <para> <para>The private key; the contents of the certificate's domain.kex file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Shortname"> <summary> <para> <para>The app's short name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.Type"> <summary> <para> <para>The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify <code>other</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Url"> <summary> <para> <para>The source URL. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.AppSource_Username"> <summary> <para> <para>This parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</li><li>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSAppCmdlet.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.OPS.NewOPSDeploymentCmdlet"> <summary> Runs deployment or stack commands. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html">Deploying Apps</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html">Run Stack Commands</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.AppId"> <summary> <para> <para>The app ID. This parameter is required for app deployments, but not for other deployment commands.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.Command_Arg"> <summary> <para> <para>The arguments of those commands that take arguments. It should be set to a JSON object with the following format:</para><para><code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code></para><para>The <code>update_dependencies</code> command takes two arguments:</para><ul><li><code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as <code>Amazon Linux 2014.09</code>. You must also set the <code>allow_reboot</code> argument to true.</li><li><code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks to reboot the instances if necessary, after installing the updates. This argument can be set to either <code>true</code> or <code>false</code>. The default value is <code>false</code>.</li></ul><para>For example, to upgrade an instance to Amazon Linux 2014.09, set <code>Args</code> to the following.</para><code> { "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] } </code> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.Comment"> <summary> <para> <para>A user-defined comment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.CustomJson"> <summary> <para> <para>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format and must escape characters such as '"':</para><para><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></para><para>For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.InstanceId"> <summary> <para> <para>The instance IDs for the deployment targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.Command_Name"> <summary> <para> <para>Specifies the operation. You can specify only one command.</para><para>For stacks, the following commands are available:</para><ul><li><code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>.</li><li><code>install_dependencies</code>: Install the stack's dependencies.</li><li><code>update_custom_cookbooks</code>: Update the stack's custom cookbooks.</li><li><code>update_dependencies</code>: Update the stack's dependencies.</li></ul><note>The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.</note><para>For apps, the following commands are available:</para><ul><li><code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}.</li><li><code>rollback</code> Roll the app back to the previous version. When you update an app, AWS OpsWorks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.</li><li><code>start</code>: Start the app's web or application server.</li><li><code>stop</code>: Stop the app's web or application server.</li><li><code>restart</code>: Restart the app's web or application server.</li><li><code>undeploy</code>: Undeploy the app.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSDeploymentCmdlet.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.OPS.NewOPSInstanceCmdlet"> <summary> Creates an instance in a specified stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html">Adding an Instance to a Layer</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks agent version. You have the following options:</para><ul><li><code>INHERIT</code> - Use the stack's default agent version setting.</li><li><i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.</li></ul><para>The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.AmiId"> <summary> <para> <para>A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</para><note>If you specify a custom AMI, you must set <code>Os</code> to <code>Custom</code>.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.Architecture"> <summary> <para> <para>The instance architecture. The default option is <code>x86_64</code>. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.AutoScalingType"> <summary> <para> <para>For load-based or time-based instances, the type. Windows stacks can use only time-based instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.AvailabilityZone"> <summary> <para> <para>The instance Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.BlockDeviceMapping"> <summary> <para> <para>An array of <code>BlockDeviceMapping</code> objects that specify the instance's block devices. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.EbsOptimized"> <summary> <para> <para>Whether to create an Amazon EBS-optimized instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.Hostname"> <summary> <para> <para>The instance host name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.InstallUpdatesOnBoot"> <summary> <para> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. </para><note><para>We strongly recommend using the default value of <code>true</code> to ensure that your instances have the latest security updates.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.InstanceType"> <summary> <para> <para>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.LayerId"> <summary> <para> <para>An array that contains the instance's layer IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.Os"> <summary> <para> <para>The instance's operating system, which must be set to one of the following.</para><ul><li>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2015.03</code>, <code>Red Hat Enterprise Linux 7</code>, <code>Ubuntu 12.04 LTS</code>, or <code>Ubuntu 14.04 LTS</code>.</li><li><code>Microsoft Windows Server 2012 R2 Base</code>.</li><li>A custom AMI: <code>Custom</code>.</li></ul><para>For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Operating Systems</a>.</para><para>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <a>CreateInstance</a> action's AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>For more information on how to use custom AMIs with AWS OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.RootDeviceType"> <summary> <para> <para>The instance root device type. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.SshKeyName"> <summary> <para> <para>The instance's Amazon EC2 key-pair name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.SubnetId"> <summary> <para> <para>The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.VirtualizationType"> <summary> <para> <para>The instance's virtualization type, <code>paravirtual</code> or <code>hvm</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSInstanceCmdlet.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.OPS.NewOPSLayerCmdlet"> <summary> Creates a layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html">How to Create a Layer</a>. <note><para> You should use <b>CreateLayer</b> for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, <b>CreateLayer</b> fails. A stack can have an arbitrary number of custom layers, so you can call <b>CreateLayer</b> as many times as you like for that layer type. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key-value pairs to be added to the stack attributes.</para><para>To create a cluster layer, set the <code>EcsClusterArn</code> attribute to the cluster's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.AutoAssignElasticIp"> <summary> <para> <para>Whether to automatically assign an <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.AutoAssignPublicIp"> <summary> <para> <para>For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Configure"> <summary> <para> <para>An array of custom recipe names to be run following a <code>configure</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomInstanceProfileArn"> <summary> <para> <para>The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomJson"> <summary> <para> <para>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomSecurityGroupId"> <summary> <para> <para>An array containing the layer custom security group IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Shutdown_DelayUntilElbConnectionsDrained"> <summary> <para> <para>Whether to enable Elastic Load Balancing connection draining. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Deploy"> <summary> <para> <para>An array of custom recipe names to be run following a <code>deploy</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.EnableAutoHealing"> <summary> <para> <para>Whether to disable auto healing for the layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Shutdown_ExecutionTimeout"> <summary> <para> <para>The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.InstallUpdatesOnBoot"> <summary> <para> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. </para><note><para>To ensure that your instances have the latest security updates, we strongly recommend using the default value of <code>true</code>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Name"> <summary> <para> <para>The layer name, which is used by the console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Package"> <summary> <para> <para>An array of <code>Package</code> objects that describes the layer packages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Setup"> <summary> <para> <para>An array of custom recipe names to be run following a <code>setup</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Shortname"> <summary> <para> <para>For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.</para><para>The built-in layers' short names are defined by AWS OpsWorks. For more information, see the <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer Reference</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Shutdown"> <summary> <para> <para>An array of custom recipe names to be run following a <code>shutdown</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.StackId"> <summary> <para> <para>The layer stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.Type"> <summary> <para> <para>The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.CustomRecipes_Undeploy"> <summary> <para> <para>An array of custom recipe names to be run following a <code>undeploy</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.UseEbsOptimizedInstance"> <summary> <para> <para>Whether to use Amazon EBS-optimized instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.VolumeConfiguration"> <summary> <para> <para>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSLayerCmdlet.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.OPS.NewOPSStackCmdlet"> <summary> Creates a new stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html">Create a New Stack</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks agent version. You have the following options:</para><ul><li>Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.</li><li>Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.</li></ul><para>The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>.</para><note>You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key-value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ChefConfiguration_BerkshelfVersion"> <summary> <para> <para>The Berkshelf version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomJson"> <summary> <para> <para>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following escape characters such as '"':</para><para><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></para><para>For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultAvailabilityZone"> <summary> <para> <para>The stack's default Availability Zone, which must be in the specified region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultInstanceProfileArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultOs"> <summary> <para> <para>The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.</para><ul><li>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2015.03</code>, <code>Red Hat Enterprise Linux 7</code>, <code>Ubuntu 12.04 LTS</code>, or <code>Ubuntu 14.04 LTS</code>.</li><li><code>Microsoft Windows Server 2012 R2 Base</code>.</li><li>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html"> Using Custom AMIs</a>.</li></ul><para>The default option is the current Amazon Linux version. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Operating Systems</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultRootDeviceType"> <summary> <para> <para>The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is <code>instance-store</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultSshKeyName"> <summary> <para> <para>A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.DefaultSubnetId"> <summary> <para> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.HostnameTheme"> <summary> <para> <para>The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are:</para><ul><li><code>Baked_Goods</code></li><li><code>Clouds</code></li><li><code>Europe_Cities</code></li><li><code>Fruits</code></li><li><code>Greek_Deities</code></li><li><code>Legendary_creatures_from_Japan</code></li><li><code>Planets_and_Moons</code></li><li><code>Roman_Deities</code></li><li><code>Scottish_Islands</code></li><li><code>US_Cities</code></li><li><code>Wild_Cats</code></li></ul><para>To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ChefConfiguration_ManageBerkshelf"> <summary> <para> <para>Whether to enable Berkshelf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ConfigurationManager_Name"> <summary> <para> <para>The name. This parameter must be set to "Chef".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.Name"> <summary> <para> <para>The stack name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</li><li>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</li></ul><para>For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"></a>.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.StackRegion"> <summary> <para> <para>The stack's AWS region, such as "us-east-1". For more information about Amazon regions, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ServiceRoleArn"> <summary> <para> <para>The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Url"> <summary> <para> <para>The source URL. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.UseCustomCookbook"> <summary> <para> <para>Whether the stack uses custom cookbooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.UseOpsworksSecurityGroup"> <summary> <para> <para>Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.</para><para>AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With <code>UseOpsworksSecurityGroups</code> you can instead provide your own custom security groups. <code>UseOpsworksSecurityGroups</code> has the following settings: </para><ul><li>True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. </li><li>False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. </li></ul><para>For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.CustomCookbooksSource_Username"> <summary> <para> <para>This parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</li><li>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.ConfigurationManager_Version"> <summary> <para> <para>The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.VpcId"> <summary> <para> <para>The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.</para><ul><li>If your account supports EC2-Classic, the default value is <code>no VPC</code>.</li><li>If your account does not support EC2-Classic, the default value is the default VPC for the specified region.</li></ul><para>If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.</para><para>If you specify a nondefault VPC ID, note the following:</para><ul><li>It must belong to a VPC in your account that is in the specified region.</li><li>You must specify a value for <code>DefaultSubnetId</code>.</li></ul><para>For more information on how to use AWS OpsWorks with a VPC, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html">Running a Stack in a VPC</a>. For more information on default VPC and EC2-Classic, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSStackCmdlet.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.OPS.NewOPSUserProfileCmdlet"> <summary> Creates a new user profile. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.AllowSelfManagement"> <summary> <para> <para>Whether users can specify their own SSH public key through the My Settings page. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html">Setting an IAM User's Public SSH Key</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.IamUserArn"> <summary> <para> <para>The user's IAM ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.SshPublicKey"> <summary> <para> <para>The user's public SSH key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.SshUsername"> <summary> <para> <para>The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, <code>my.name</code> will be changed to <code>myname</code>. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.NewOPSUserProfileCmdlet.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.OPS.RegisterOPSEcsClusterCmdlet"> <summary> Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html"> Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"> Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSEcsClusterCmdlet.EcsClusterArn"> <summary> <para> <para>The cluster's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSEcsClusterCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSEcsClusterCmdlet.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.OPS.RegisterOPSElasticIpCmdlet"> <summary> Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling <a>DeregisterElasticIp</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSElasticIpCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSElasticIpCmdlet.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.OPS.RegisterOPSInstanceCmdlet"> <summary> Registers instances with a specified stack that were created outside of AWS OpsWorks. <note>We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. <code>RegisterInstance</code> handles only the second step. You should instead use the AWS CLI <code>register</code> command, which performs the entire registration operation. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html"> Registering an Instance with an AWS OpsWorks Stack</a>.</note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.InstanceIdentity_Document"> <summary> <para> <para>A JSON document that contains the metadata. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.Hostname"> <summary> <para> <para>The instance's hostname.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.PrivateIp"> <summary> <para> <para>The instance's private IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.PublicIp"> <summary> <para> <para>The instance's public IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.RsaPublicKey"> <summary> <para> <para>The instances public RSA key. This key is used to encrypt communication between the instance and the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.RsaPublicKeyFingerprint"> <summary> <para> <para>The instances public RSA key fingerprint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.InstanceIdentity_Signature"> <summary> <para> <para>A signature that can be used to verify the document's accuracy and authenticity. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.StackId"> <summary> <para> <para>The ID of the stack that the instance is to be registered with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceCmdlet.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.OPS.RegisterOPSInstanceAssignmentCmdlet"> <summary> Assign a registered instance to a layer. <ul><li>You can assign registered on-premises instances to any layer type.</li><li>You can assign registered Amazon EC2 instances only to custom layers.</li><li>You cannot use this action with instances that were created with AWS OpsWorks.</li></ul><para><b>Required Permissions</b>: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceAssignmentCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceAssignmentCmdlet.LayerId"> <summary> <para> <para>The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceAssignmentCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSInstanceAssignmentCmdlet.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.OPS.RegisterOPSRdsDbInstanceCmdlet"> <summary> Registers an Amazon RDS instance with a stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.DbPassword"> <summary> <para> <para>The database password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.DbUser"> <summary> <para> <para>The database's master user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.RdsDbInstanceArn"> <summary> <para> <para>The Amazon RDS instance's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSRdsDbInstanceCmdlet.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.OPS.RegisterOPSVolumeCmdlet"> <summary> Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling <a>DeregisterVolume</a>. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSVolumeCmdlet.Ec2VolumeId"> <summary> <para> <para>The Amazon EBS volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSVolumeCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RegisterOPSVolumeCmdlet.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.OPS.RemoveOPSAppCmdlet"> <summary> Deletes a specified app. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSAppCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSAppCmdlet.PassThru"> <summary> Returns the value passed to the AppId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSAppCmdlet.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.OPS.RemoveOPSElasticIpCmdlet"> <summary> Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSElasticIpCmdlet.PassThru"> <summary> Returns the value passed to the ElasticIp parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSElasticIpCmdlet.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.OPS.RemoveOPSInstanceCmdlet"> <summary> Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it. <para> For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html">Deleting Instances</a>. </para><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.DeleteElasticIp"> <summary> <para> <para>Whether to delete the instance Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.DeleteVolume"> <summary> <para> <para>Whether to delete the instance's Amazon EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSInstanceCmdlet.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.OPS.RemoveOPSLayerCmdlet"> <summary> Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html">How to Delete a Layer</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSLayerCmdlet.LayerId"> <summary> <para> <para>The layer ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSLayerCmdlet.PassThru"> <summary> Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSLayerCmdlet.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.OPS.RemoveOPSStackCmdlet"> <summary> Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html">Shut Down a Stack</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSStackCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSStackCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSStackCmdlet.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.OPS.RemoveOPSUserProfileCmdlet"> <summary> Deletes a user profile. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSUserProfileCmdlet.IamUserArn"> <summary> <para> <para>The user's IAM ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSUserProfileCmdlet.PassThru"> <summary> Returns the value passed to the IamUserArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSUserProfileCmdlet.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.OPS.RemoveOPSVolumeCmdlet"> <summary> Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>The volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSVolumeCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RemoveOPSVolumeCmdlet.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.OPS.RestartOPSInstanceCmdlet"> <summary> Reboots a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RestartOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RestartOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.RestartOPSInstanceCmdlet.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.OPS.SetOPSLoadBasedAutoScalingCmdlet"> <summary> Specify the load-based auto scaling configuration for a specified layer. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <note><para> To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. </para></note><para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_Alarm"> <summary> <para> <para>Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.</para><note>To use custom alarms, you must update your service role to allow <code>cloudwatch:DescribeAlarms</code>. You can either have AWS OpsWorks update the role for you when you first use this feature or you can edit the role manually. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html">Allowing AWS OpsWorks to Act on Your Behalf</a>.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_Alarm"> <summary> <para> <para>Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.</para><note>To use custom alarms, you must update your service role to allow <code>cloudwatch:DescribeAlarms</code>. You can either have AWS OpsWorks update the role for you when you first use this feature or you can edit the role manually. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-servicerole.html">Allowing AWS OpsWorks to Act on Your Behalf</a>.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_CpuThreshold"> <summary> <para> <para>The CPU utilization threshold, as a percent of the available CPU.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_CpuThreshold"> <summary> <para> <para>The CPU utilization threshold, as a percent of the available CPU.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.Enable"> <summary> <para> <para>Enables load-based auto scaling for the layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_IgnoreMetricsTime"> <summary> <para> <para>The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. <code>IgnoreMetricsTime</code> allows you to direct AWS OpsWorks to suppress scaling events long enough to get the new instances online.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_IgnoreMetricsTime"> <summary> <para> <para>The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. <code>IgnoreMetricsTime</code> allows you to direct AWS OpsWorks to suppress scaling events long enough to get the new instances online.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_InstanceCount"> <summary> <para> <para>The number of instances to add or remove when the load exceeds a threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_InstanceCount"> <summary> <para> <para>The number of instances to add or remove when the load exceeds a threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.LayerId"> <summary> <para> <para>The layer ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_LoadThreshold"> <summary> <para> <para>The load threshold. For more information about how load is computed, see <a href="http://en.wikipedia.org/wiki/Load_%28computing%29">Load (computing)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_LoadThreshold"> <summary> <para> <para>The load threshold. For more information about how load is computed, see <a href="http://en.wikipedia.org/wiki/Load_%28computing%29">Load (computing)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_MemoryThreshold"> <summary> <para> <para>The memory utilization threshold, as a percent of the available memory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_MemoryThreshold"> <summary> <para> <para>The memory utilization threshold, as a percent of the available memory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.DownScaling_ThresholdsWaitTime"> <summary> <para> <para>The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.UpScaling_ThresholdsWaitTime"> <summary> <para> <para>The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.PassThru"> <summary> Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSLoadBasedAutoScalingCmdlet.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.OPS.SetOPSPermissionCmdlet"> <summary> Specifies a user's permissions. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html">Security and Permissions</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.AllowSsh"> <summary> <para> <para>The user is allowed to use SSH to communicate with the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.AllowSudo"> <summary> <para> <para>The user is allowed to use <b>sudo</b> to elevate privileges.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.IamUserArn"> <summary> <para> <para>The user's IAM ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.Level"> <summary> <para> <para>The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.</para><ul><li><code>deny</code></li><li><code>show</code></li><li><code>deploy</code></li><li><code>manage</code></li><li><code>iam_only</code></li></ul><para>For more information on the permissions associated with these levels, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSPermissionCmdlet.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.OPS.SetOPSTimeBasedAutoScalingCmdlet"> <summary> Specify the time-based auto scaling configuration for a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html">Managing Load with Time-based and Load-based Instances</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Friday"> <summary> <para> <para>The schedule for Friday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Monday"> <summary> <para> <para>The schedule for Monday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Saturday"> <summary> <para> <para>The schedule for Saturday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Sunday"> <summary> <para> <para>The schedule for Sunday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Thursday"> <summary> <para> <para>The schedule for Thursday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Tuesday"> <summary> <para> <para>The schedule for Tuesday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.AutoScalingSchedule_Wednesday"> <summary> <para> <para>The schedule for Wednesday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.SetOPSTimeBasedAutoScalingCmdlet.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.OPS.StartOPSInstanceCmdlet"> <summary> Starts a specified instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSInstanceCmdlet.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.OPS.StartOPSStackCmdlet"> <summary> Starts a stack's instances. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSStackCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSStackCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StartOPSStackCmdlet.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.OPS.StopOPSInstanceCmdlet"> <summary> Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html">Starting, Stopping, and Rebooting Instances</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSInstanceCmdlet.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.OPS.StopOPSStackCmdlet"> <summary> Stops a specified stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSStackCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSStackCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.StopOPSStackCmdlet.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.OPS.UnregisterOPSEcsClusterCmdlet"> <summary> Deregisters a specified Amazon ECS cluster from a stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete"> Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html"></a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSEcsClusterCmdlet.EcsClusterArn"> <summary> <para> <para>The cluster's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSEcsClusterCmdlet.PassThru"> <summary> Returns the value passed to the EcsClusterArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSEcsClusterCmdlet.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.OPS.UnregisterOPSElasticIpCmdlet"> <summary> Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSElasticIpCmdlet.PassThru"> <summary> Returns the value passed to the ElasticIp parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSElasticIpCmdlet.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.OPS.UnregisterOPSInstanceCmdlet"> <summary> Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceCmdlet.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.OPS.UnregisterOPSInstanceAssignmentCmdlet"> <summary> Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceAssignmentCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceAssignmentCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSInstanceAssignmentCmdlet.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.OPS.UnregisterOPSRdsDbInstanceCmdlet"> <summary> Deregisters an Amazon RDS instance. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSRdsDbInstanceCmdlet.RdsDbInstanceArn"> <summary> <para> <para>The Amazon RDS instance's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSRdsDbInstanceCmdlet.PassThru"> <summary> Returns the value passed to the RdsDbInstanceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSRdsDbInstanceCmdlet.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.OPS.UnregisterOPSVolumeCmdlet"> <summary> Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>The AWS OpsWorks volume ID, which is the GUID that AWS OpsWorks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSVolumeCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UnregisterOPSVolumeCmdlet.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.OPS.UpdateOPSAppCmdlet"> <summary> Updates a specified app. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppId"> <summary> <para> <para>The app ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key/value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.SslConfiguration_Certificate"> <summary> <para> <para>The contents of the certificate's domain.crt file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.SslConfiguration_Chain"> <summary> <para> <para>Optional. Can be used to specify an intermediate certificate authority key or client authentication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.DataSource"> <summary> <para> <para>The app's data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Description"> <summary> <para> <para>A description of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Domain"> <summary> <para> <para>The app's virtual host settings, with multiple domains separated by commas. For example: <code>'www.example.com, example.com'</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.EnableSsl"> <summary> <para> <para>Whether SSL is enabled for the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Environment"> <summary> <para> <para>An array of <code>EnvironmentVariable</code> objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment"> Environment Variables</a>.</para><para> There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)." </para><note>This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Name"> <summary> <para> <para>The app name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</li><li>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</li></ul><para>For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"></a>.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.SslConfiguration_PrivateKey"> <summary> <para> <para>The private key; the contents of the certificate's domain.kex file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.Type"> <summary> <para> <para>The app type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Url"> <summary> <para> <para>The source URL. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.AppSource_Username"> <summary> <para> <para>This parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</li><li>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.PassThru"> <summary> Returns the value passed to the AppId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSAppCmdlet.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.OPS.UpdateOPSElasticIpCmdlet"> <summary> Updates a registered Elastic IP address's name. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSElasticIpCmdlet.ElasticIp"> <summary> <para> <para>The address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSElasticIpCmdlet.Name"> <summary> <para> <para>The new name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSElasticIpCmdlet.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.OPS.UpdateOPSInstanceCmdlet"> <summary> Updates a specified instance. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks agent version. You have the following options:</para><ul><li><code>INHERIT</code> - Use the stack's default agent version setting.</li><li><i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.</li></ul><para>The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.AmiId"> <summary> <para> <para>A custom AMI ID to be used to create the instance. The AMI must be based on one of the supported operating systems. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Instances</a></para><note>If you specify a custom AMI, you must set <code>Os</code> to <code>Custom</code>.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.Architecture"> <summary> <para> <para>The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.AutoScalingType"> <summary> <para> <para>For load-based or time-based instances, the type. Windows stacks can use only time-based instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.EbsOptimized"> <summary> <para> <para>This property cannot be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.Hostname"> <summary> <para> <para>The instance host name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.InstallUpdatesOnBoot"> <summary> <para> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. </para><note><para>We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.InstanceType"> <summary> <para> <para>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.LayerId"> <summary> <para> <para>The instance's layer IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.Os"> <summary> <para> <para>The instance's operating system, which must be set to one of the following.</para><ul><li>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2015.03</code>, <code>Red Hat Enterprise Linux 7</code>, <code>Ubuntu 12.04 LTS</code>, or <code>Ubuntu 14.04 LTS</code>.</li><li><code>Microsoft Windows Server 2012 R2 Base</code>.</li><li>A custom AMI: <code>Custom</code>.</li></ul><para>For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Operating Systems</a>.</para><para>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</para><note>You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.SshKeyName"> <summary> <para> <para>The instance's Amazon EC2 key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSInstanceCmdlet.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.OPS.UpdateOPSLayerCmdlet"> <summary> Updates a specified layer. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key/value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.AutoAssignElasticIp"> <summary> <para> <para>Whether to automatically assign an <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.AutoAssignPublicIp"> <summary> <para> <para>For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Configure"> <summary> <para> <para>An array of custom recipe names to be run following a <code>configure</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomInstanceProfileArn"> <summary> <para> <para>The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomJson"> <summary> <para> <para>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomSecurityGroupId"> <summary> <para> <para>An array containing the layer's custom security group IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Shutdown_DelayUntilElbConnectionsDrained"> <summary> <para> <para>Whether to enable Elastic Load Balancing connection draining. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain">Connection Draining</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Deploy"> <summary> <para> <para>An array of custom recipe names to be run following a <code>deploy</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.EnableAutoHealing"> <summary> <para> <para>Whether to disable auto healing for the layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Shutdown_ExecutionTimeout"> <summary> <para> <para>The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.InstallUpdatesOnBoot"> <summary> <para> <para>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <a>CreateDeployment</a> to run the <code>update_dependencies</code> stack command or manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances. </para><note><para>We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.LayerId"> <summary> <para> <para>The layer ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Name"> <summary> <para> <para>The layer name, which is used by the console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Package"> <summary> <para> <para>An array of <code>Package</code> objects that describe the layer's packages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Setup"> <summary> <para> <para>An array of custom recipe names to be run following a <code>setup</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.Shortname"> <summary> <para> <para>For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.</para><para>The built-in layers' short names are defined by AWS OpsWorks. For more information, see the <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer Reference</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Shutdown"> <summary> <para> <para>An array of custom recipe names to be run following a <code>shutdown</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.CustomRecipes_Undeploy"> <summary> <para> <para>An array of custom recipe names to be run following a <code>undeploy</code> event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.UseEbsOptimizedInstance"> <summary> <para> <para>Whether to use Amazon EBS-optimized instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.VolumeConfiguration"> <summary> <para> <para>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.PassThru"> <summary> Returns the value passed to the LayerId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSLayerCmdlet.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.OPS.UpdateOPSMyUserProfileCmdlet"> <summary> Updates a user's SSH public key. <para><b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSMyUserProfileCmdlet.SshPublicKey"> <summary> <para> <para>The user's SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSMyUserProfileCmdlet.PassThru"> <summary> Returns the value passed to the SshPublicKey parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSMyUserProfileCmdlet.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.OPS.UpdateOPSRdsDbInstanceCmdlet"> <summary> Updates an Amazon RDS instance. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.DbPassword"> <summary> <para> <para>The database password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.DbUser"> <summary> <para> <para>The master user name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.RdsDbInstanceArn"> <summary> <para> <para>The Amazon RDS instance's ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.PassThru"> <summary> Returns the value passed to the RdsDbInstanceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSRdsDbInstanceCmdlet.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.OPS.UpdateOPSStackCmdlet"> <summary> Updates a specified stack. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.AgentVersion"> <summary> <para> <para>The default AWS OpsWorks agent version. You have the following options:</para><ul><li>Auto-update - Set this parameter to <code>LATEST</code>. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.</li><li>Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.</li></ul><para>The default setting is <code>LATEST</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <a>DescribeAgentVersions</a>.</para><note>You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.Attribute"> <summary> <para> <para>One or more user-defined key-value pairs to be added to the stack attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ChefConfiguration_BerkshelfVersion"> <summary> <para> <para>The Berkshelf version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomJson"> <summary> <para> <para>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format and escape characters such as '"':</para><para><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></para><para>For more information on custom JSON, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultAvailabilityZone"> <summary> <para> <para>The stack's default Availability Zone, which must be in the stack's region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. If you also specify a value for <code>DefaultSubnetId</code>, the subnet must be in the same zone. For more information, see <a>CreateStack</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultInstanceProfileArn"> <summary> <para> <para>The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultOs"> <summary> <para> <para>The stack's operating system, which must be set to one of the following:</para><ul><li>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2015.03</code>, <code>Red Hat Enterprise Linux 7</code>, <code>Ubuntu 12.04 LTS</code>, or <code>Ubuntu 14.04 LTS</code>.</li><li><code>Microsoft Windows Server 2012 R2 Base</code>.</li><li>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</li></ul><para>The default option is the stack's current operating system. For more information on the supported operating systems, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Operating Systems</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultRootDeviceType"> <summary> <para> <para>The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultSshKeyName"> <summary> <para> <para>A default Amazon EC2 key-pair name. The default value is <code>none</code>. If you specify a key-pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html"> Using SSH to Communicate with an Instance</a> and <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html"> Managing SSH Access</a>. You can override this setting by specifying a different key pair, or no key pair, when you <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html"> create an instance</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.DefaultSubnetId"> <summary> <para> <para>The stack's default VPC subnet ID. This parameter is required if you specify a value for the <code>VpcId</code> parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for <code>DefaultAvailabilityZone</code>, the subnet must be in that zone. For information on default values and when this parameter is required, see the <code>VpcId</code> parameter description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.HostnameTheme"> <summary> <para> <para>The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, <code>HostnameTheme</code> is set to <code>Layer_Dependent</code>, which creates host names by appending integers to the layer's short name. The other themes are:</para><ul><li><code>Baked_Goods</code></li><li><code>Clouds</code></li><li><code>Europe_Cities</code></li><li><code>Fruits</code></li><li><code>Greek_Deities</code></li><li><code>Legendary_creatures_from_Japan</code></li><li><code>Planets_and_Moons</code></li><li><code>Roman_Deities</code></li><li><code>Scottish_Islands</code></li><li><code>US_Cities</code></li><li><code>Wild_Cats</code></li></ul><para>To obtain a generated host name, call <code>GetHostNameSuggestion</code>, which returns a host name based on the current theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ChefConfiguration_ManageBerkshelf"> <summary> <para> <para>Whether to enable Berkshelf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ConfigurationManager_Name"> <summary> <para> <para>The name. This parameter must be set to "Chef".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.Name"> <summary> <para> <para>The stack's new name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Password"> <summary> <para> <para>When included in a request, the parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Password</code> to the appropriate IAM secret access key.</li><li>For HTTP bundles and Subversion repositories, set <code>Password</code> to the password.</li></ul><para>For more information on how to safely handle IAM credentials, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"></a>.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Revision"> <summary> <para> <para>The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ServiceRoleArn"> <summary> <para> <para>Do not use this parameter. You cannot update a stack's service role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_SshKey"> <summary> <para> <para>In requests, the repository's SSH key.</para><para>In responses, AWS OpsWorks returns <code>*****FILTERED*****</code> instead of the actual value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.StackId"> <summary> <para> <para>The stack ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Type"> <summary> <para> <para>The repository type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Url"> <summary> <para> <para>The source URL. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.UseCustomCookbook"> <summary> <para> <para>Whether the stack uses custom cookbooks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.UseOpsworksSecurityGroup"> <summary> <para> <para>Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.</para><para>AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. <code>UseOpsworksSecurityGroups</code> allows you to provide your own custom security groups instead of using the built-in groups. <code>UseOpsworksSecurityGroups</code> has the following settings: </para><ul><li>True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. </li><li>False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings. </li></ul><para>For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html">Create a New Stack</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.CustomCookbooksSource_Username"> <summary> <para> <para>This parameter depends on the repository type. </para><ul><li>For Amazon S3 bundles, set <code>Username</code> to the appropriate IAM access key ID.</li><li>For HTTP bundles, Git repositories, and Subversion repositories, set <code>Username</code> to the user name.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.ConfigurationManager_Version"> <summary> <para> <para>The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.PassThru"> <summary> Returns the value passed to the StackId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSStackCmdlet.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.OPS.UpdateOPSUserProfileCmdlet"> <summary> Updates a specified user profile. <para><b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.AllowSelfManagement"> <summary> <para> <para>Whether users can specify their own SSH public key through the My Settings page. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html">Managing User Permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.IamUserArn"> <summary> <para> <para>The user IAM ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.SshPublicKey"> <summary> <para> <para>The user's new SSH public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.SshUsername"> <summary> <para> <para>The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, <code>my.name</code> will be changed to <code>myname</code>. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.PassThru"> <summary> Returns the value passed to the IamUserArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSUserProfileCmdlet.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.OPS.UpdateOPSVolumeCmdlet"> <summary> Updates an Amazon EBS volume's name or mount point. For more information, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>. <para><b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.MountPoint"> <summary> <para> <para>The new mount point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.Name"> <summary> <para> <para>The new name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.VolumeId"> <summary> <para> <para>The volume ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.PassThru"> <summary> Returns the value passed to the VolumeId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OPS.UpdateOPSVolumeCmdlet.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.RDS.AddRDSSourceIdentifierToSubscriptionCmdlet"> <summary> Adds a source identifier to an existing RDS event notification subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.AddRDSSourceIdentifierToSubscriptionCmdlet.SourceIdentifier"> <summary> <para> <para> The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. </para><para>Constraints:</para><ul><li>If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied.</li><li>If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied.</li><li>If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied.</li><li>If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.AddRDSSourceIdentifierToSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the RDS event notification subscription you want to add a source identifier to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.AddRDSSourceIdentifierToSubscriptionCmdlet.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.RDS.AddRDSTagsToResourceCmdlet"> <summary> Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. <para> For an overview on tagging Amazon RDS resources, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.AddRDSTagsToResourceCmdlet.ResourceName"> <summary> <para> <para>The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"> Constructing an RDS Amazon Resource Name (ARN)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.AddRDSTagsToResourceCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the Amazon RDS resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.AddRDSTagsToResourceCmdlet.PassThru"> <summary> Returns the collection of tags that were added. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.AddRDSTagsToResourceCmdlet.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.RDS.ConvertRDSReadReplicaToStandaloneCmdlet"> <summary> Promotes a Read Replica DB instance to a standalone DB instance. <note><para> We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ConvertRDSReadReplicaToStandaloneCmdlet.BackupRetentionPeriod"> <summary> <para> <para> The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. </para><para> Default: 1 </para><para>Constraints:</para><ul><li>Must be a value from 0 to 8</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ConvertRDSReadReplicaToStandaloneCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The DB instance identifier. This value is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must be the identifier for an existing Read Replica DB instance</li><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>mydbinstance</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ConvertRDSReadReplicaToStandaloneCmdlet.PreferredBackupWindow"> <summary> <para> <para> The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. </para><para> Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i></para><para>Constraints:</para><ul><li>Must be in the format <code>hh24:mi-hh24:mi</code>.</li><li>Times should be in Universal Coordinated Time (UTC).</li><li>Must not conflict with the preferred maintenance window.</li><li>Must be at least 30 minutes.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ConvertRDSReadReplicaToStandaloneCmdlet.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.RDS.CopyRDSDBClusterSnapshotCmdlet"> <summary> Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBClusterSnapshotCmdlet.SourceDBClusterSnapshotIdentifier"> <summary> <para> <para>The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul><para>Example: <code>my-cluster-snapshot1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBClusterSnapshotCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBClusterSnapshotCmdlet.TargetDBClusterSnapshotIdentifier"> <summary> <para> <para>The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul><para>Example: <code>my-cluster-snapshot2</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBClusterSnapshotCmdlet.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.RDS.CopyRDSDBParameterGroupCmdlet"> <summary> Copies the specified DB parameter group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBParameterGroupCmdlet.SourceDBParameterGroupIdentifier"> <summary> <para> <para> The identifier or ARN for the source DB parameter group. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"> Constructing an RDS Amazon Resource Name (ARN)</a>. </para><para>Constraints:</para><ul><li>Must specify a valid DB parameter group.</li><li>If the source DB parameter group is in the same region as the copy, specify a valid DB parameter group identifier, for example <code>my-db-param-group</code>, or a valid ARN.</li><li>If the source DB parameter group is in a different region than the copy, specify a valid DB parameter group ARN, for example <code>arn:aws:rds:us-west-2:123456789012:pg:special-parameters</code>.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBParameterGroupCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBParameterGroupCmdlet.TargetDBParameterGroupDescription"> <summary> <para> <para>A description for the copied DB parameter group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBParameterGroupCmdlet.TargetDBParameterGroupIdentifier"> <summary> <para> <para>The identifier for the copied DB parameter group.</para><para>Constraints:</para><ul><li>Cannot be null, empty, or blank</li><li>Must contain from 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>my-db-parameter-group</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBParameterGroupCmdlet.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.RDS.CopyRDSDBSnapshotCmdlet"> <summary> Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBSnapshotCmdlet.CopyTag"> <summary> <para> <para>True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBSnapshotCmdlet.SourceDBSnapshotIdentifier"> <summary> <para> <para> The identifier for the source DB snapshot. </para><para>Constraints:</para><ul><li>Must specify a valid system snapshot in the "available" state.</li><li>If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.</li><li>If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html"> Copying a DB Snapshot</a>.</li></ul><para>Example: <code>rds:mydb-2012-04-02-00-01</code></para><para>Example: <code>arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBSnapshotCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBSnapshotCmdlet.TargetDBSnapshotIdentifier"> <summary> <para> <para> The identifier for the copied snapshot. </para><para>Constraints:</para><ul><li>Cannot be null, empty, or blank</li><li>Must contain from 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>my-db-snapshot</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSDBSnapshotCmdlet.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.RDS.CopyRDSOptionGroupCmdlet"> <summary> Copies the specified option group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSOptionGroupCmdlet.SourceOptionGroupIdentifier"> <summary> <para> <para>The identifier or ARN for the source option group. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"> Constructing an RDS Amazon Resource Name (ARN)</a>. </para><para>Constraints:</para><ul><li>Must specify a valid option group.</li><li>If the source option group is in the same region as the copy, specify a valid option group identifier, for example <code>my-option-group</code>, or a valid ARN.</li><li>If the source option group is in a different region than the copy, specify a valid option group ARN, for example <code>arn:aws:rds:us-west-2:123456789012:og:special-options</code>.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSOptionGroupCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSOptionGroupCmdlet.TargetOptionGroupDescription"> <summary> <para> <para>The description for the copied option group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSOptionGroupCmdlet.TargetOptionGroupIdentifier"> <summary> <para> <para>The identifier for the copied option group. </para><para>Constraints:</para><ul><li>Cannot be null, empty, or blank</li><li>Must contain from 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>my-option-group</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.CopyRDSOptionGroupCmdlet.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.RDS.EditRDSDBClusterCmdlet"> <summary> Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.ApplyImmediately"> <summary> <para> <para>A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB cluster. </para><para>If this parameter is set to <code>false</code>, changes to the DB cluster are applied during the next maintenance window.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.BackupRetentionPeriod"> <summary> <para> <para>The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. </para><para>Default: 1 </para><para>Constraints:</para><ul><li>Must be a value from 0 to 35</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.DBClusterIdentifier"> <summary> <para> <para>The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. </para><para>Constraints:</para><ul><li>Must be the identifier for an existing DB cluster.</li><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.DBClusterParameterGroupName"> <summary> <para> <para>The name of the DB cluster parameter group to use for the DB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.MasterUserPassword"> <summary> <para> <para>The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". </para><para>Constraints: Must contain from 8 to 41 characters. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.NewDBClusterIdentifier"> <summary> <para> <para>The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>my-cluster2</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.OptionGroupName"> <summary> <para> <para>A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. </para><para>Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.Port"> <summary> <para> <para> The port number on which the DB cluster accepts connections. </para><para>Constraints: Value must be <code>1150-65535</code></para><para>Default: The same port as the original DB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.PreferredBackupWindow"> <summary> <para> <para>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. </para><para>Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i></para><para>Constraints:</para><ul><li>Must be in the format <code>hh24:mi-hh24:mi</code>.</li><li>Times should be in Universal Coordinated Time (UTC).</li><li>Must not conflict with the preferred maintenance window.</li><li>Must be at least 30 minutes.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). </para><para> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></para><para>Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i></para><para>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</para><para>Constraints: Minimum 30-minute window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.VpcSecurityGroupId"> <summary> <para> <para> A lst of VPC security groups that the DB cluster will belong to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterCmdlet.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.RDS.EditRDSDBClusterParameterGroupCmdlet"> <summary> Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para><note><para> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. </para></note><important><para> After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterParameterGroupCmdlet.DBClusterParameterGroupName"> <summary> <para> <para>The name of the DB cluster parameter group to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterParameterGroupCmdlet.Parameter"> <summary> <para> <para>A list of parameters in the DB cluster parameter group to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBClusterParameterGroupCmdlet.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.RDS.EditRDSDBInstanceCmdlet"> <summary> Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.AllocatedStorage"> <summary> <para> <para> The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless <code>ApplyImmediately</code> is set to <code>true</code> for this request. </para><para><b>MySQL</b></para><para>Default: Uses existing setting</para><para>Valid Values: 5-6144</para><para>Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.</para><para>Type: Integer</para><para><b>PostgreSQL</b></para><para>Default: Uses existing setting</para><para>Valid Values: 5-6144</para><para>Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.</para><para>Type: Integer</para><para><b>Oracle</b></para><para>Default: Uses existing setting</para><para>Valid Values: 10-6144</para><para>Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.</para><para><b>SQL Server</b></para><para>Cannot be modified.</para><para> If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.AllowMajorVersionUpgrade"> <summary> <para> <para> Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. </para><para>Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.ApplyImmediately"> <summary> <para> <para>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. </para><para> If this parameter is set to <code>false</code>, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to <a>RebootDBInstance</a>, or the next failure reboot. Review the table of parameters in <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.html#Overview.DBInstance.Modifying">Modifying a DB Instance and Using the Apply Immediately Parameter</a> to see the impact that setting <code>ApplyImmediately</code> to <code>true</code> or <code>false</code> has for each modified parameter and to determine when the changes will be applied. </para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para> Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.BackupRetentionPeriod"> <summary> <para> <para> The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. </para><para>Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.</para><para>Default: Uses existing setting</para><para>Constraints:</para><ul><li>Must be a value from 0 to 35</li><li>Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6</li><li>Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5</li><li>Cannot be set to 0 if the DB instance is a source to Read Replicas</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.CACertificateIdentifier"> <summary> <para> <para> Indicates the certificate that needs to be associated with the instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.CopyTagsToSnapshot"> <summary> <para> <para>True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.DBInstanceClass"> <summary> <para> <para> The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the <a>DescribeOrderableDBInstanceOptions</a> action. </para><para> Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless <code>ApplyImmediately</code> is specified as <code>true</code> for this request. </para><para>Default: Uses existing setting</para><para>Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The DB instance identifier. This value is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must be the identifier for an existing DB instance</li><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.DBParameterGroupName"> <summary> <para> <para> The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window. </para><para>Default: Uses existing setting</para><para>Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.DBSecurityGroup"> <summary> <para> <para> A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.EngineVersion"> <summary> <para> <para> The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. </para><para> For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. </para><para>For a list of valid engine versions, see <a>CreateDBInstance</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.Iops"> <summary> <para> <para> The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. </para><para>Default: Uses existing setting</para><para>Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.</para><para><b>SQL Server</b></para><para>Setting the IOPS value for the SQL Server database engine is not supported.</para><para>Type: Integer</para><para> If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.MasterUserPassword"> <summary> <para> <para> The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".</para><para> Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. </para><para>Default: Uses existing setting</para><para>Constraints: Must be 8 to 41 alphanumeric characters (MySQL and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).</para><note> Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.MultiAZ"> <summary> <para> <para> Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. </para><para>Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.NewDBInstanceIdentifier"> <summary> <para> <para> The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set <code>Apply Immediately</code> to true, or will occur during the next maintenance window if <code>Apply Immediately</code> to false. This value is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.OptionGroupName"> <summary> <para> <para> Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. </para><para> Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.PreferredBackupWindow"> <summary> <para> <para> The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code> parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. </para><para>Constraints:</para><ul><li>Must be in the format hh24:mi-hh24:mi</li><li>Times should be in Universal Time Coordinated (UTC)</li><li>Must not conflict with the preferred maintenance window</li><li>Must be at least 30 minutes</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para> The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. </para><para>Default: Uses existing setting</para><para>Format: ddd:hh24:mi-ddd:hh24:mi</para><para>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</para><para>Constraints: Must be at least 30 minutes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.StorageType"> <summary> <para> <para> Specifies the storage type to be associated with the DB instance. </para><para> Valid values: <code>standard | gp2 | io1</code></para><para> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </para><para> Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.TdeCredentialArn"> <summary> <para> <para> The ARN from the Key Store with which to associate the instance for TDE encryption. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.TdeCredentialPassword"> <summary> <para> <para> The password for the given ARN from the Key Store in order to access the device. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.VpcSecurityGroupId"> <summary> <para> <para> A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBInstanceCmdlet.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.RDS.EditRDSDBParameterGroupCmdlet"> <summary> Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. <note><para> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. </para></note><important><para> After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBParameterGroupCmdlet.DBParameterGroupName"> <summary> <para> <para> The name of the DB parameter group. </para><para>Constraints:</para><ul><li>Must be the name of an existing DB parameter group</li><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBParameterGroupCmdlet.Parameter"> <summary> <para> <para> An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. </para><para>Valid Values (for the application method): <code>immediate | pending-reboot</code></para><note>You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBParameterGroupCmdlet.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.RDS.EditRDSDBSubnetGroupCmdlet"> <summary> Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBSubnetGroupCmdlet.DBSubnetGroupDescription"> <summary> <para> <para> The description for the DB subnet group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBSubnetGroupCmdlet.DBSubnetGroupName"> <summary> <para> <para> The name for the DB subnet group. This value is stored as a lowercase string. </para><para>Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".</para><para>Example: <code>mySubnetgroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBSubnetGroupCmdlet.SubnetId"> <summary> <para> <para> The EC2 subnet IDs for the DB subnet group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSDBSubnetGroupCmdlet.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.RDS.EditRDSEventSubscriptionCmdlet"> <summary> Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the <a>AddSourceIdentifierToSubscription</a> and <a>RemoveSourceIdentifierFromSubscription</a> calls. <para> You can see a list of the event categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSEventSubscriptionCmdlet.Enabled"> <summary> <para> <para> A Boolean value; set to <b>true</b> to activate the subscription. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSEventSubscriptionCmdlet.EventCategory"> <summary> <para> <para> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSEventSubscriptionCmdlet.SnsTopicArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSEventSubscriptionCmdlet.SourceType"> <summary> <para> <para> The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. </para><para>Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the RDS event notification subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSEventSubscriptionCmdlet.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.RDS.EditRDSOptionGroupCmdlet"> <summary> Modifies an existing option group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSOptionGroupCmdlet.ApplyImmediately"> <summary> <para> <para> Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSOptionGroupCmdlet.OptionGroupName"> <summary> <para> <para> The name of the option group to be modified. </para><para> Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSOptionGroupCmdlet.OptionsToInclude"> <summary> <para> <para> Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSOptionGroupCmdlet.OptionsToRemove"> <summary> <para> <para> Options in this list are removed from the option group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EditRDSOptionGroupCmdlet.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.RDS.EnableRDSDBSecurityGroupIngressCmdlet"> <summary> Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). <note> You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. </note><para> For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EnableRDSDBSecurityGroupIngressCmdlet.CIDRIP"> <summary> <para> <para> The IP range to authorize. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EnableRDSDBSecurityGroupIngressCmdlet.DBSecurityGroupName"> <summary> <para> <para> The name of the DB security group to add authorization to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EnableRDSDBSecurityGroupIngressCmdlet.EC2SecurityGroupId"> <summary> <para> <para> Id of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EnableRDSDBSecurityGroupIngressCmdlet.EC2SecurityGroupName"> <summary> <para> <para> Name of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EnableRDSDBSecurityGroupIngressCmdlet.EC2SecurityGroupOwnerId"> <summary> <para> <para> AWS account number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.EnableRDSDBSecurityGroupIngressCmdlet.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.RDS.GetRDSAccountAttributesCmdlet"> <summary> Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. <para> This command does not take any parameters. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSCertificatesCmdlet"> <summary> Lists the set of CA certificates provided by Amazon RDS for this AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSCertificatesCmdlet.CertificateIdentifier"> <summary> <para> <para> The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSCertificatesCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSCertificatesCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <a>DescribeCertificates</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSCertificatesCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterCmdlet"> <summary> Returns information about provisioned Aurora DB clusters. This API supports pagination. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterCmdlet.DBClusterIdentifier"> <summary> <para> <para>The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <a>DescribeDBClusters</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterCmdlet"> <summary> Returns the detailed parameter list for a particular DB cluster parameter group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterCmdlet.DBClusterParameterGroupName"> <summary> <para> <para> The name of a specific DB cluster parameter group to return parameter details for. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterCmdlet.Source"> <summary> <para> <para> A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterGroupCmdlet"> <summary> Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain only the description of the specified DB cluster parameter group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterGroupCmdlet.DBClusterParameterGroupName"> <summary> <para> <para> The name of a specific DB cluster parameter group to return details for. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterGroupCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterGroupCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeDBClusterParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterParameterGroupCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterSnapshotCmdlet"> <summary> Returns information about DB cluster snapshots. This API supports pagination. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterSnapshotCmdlet.DBClusterIdentifier"> <summary> <para> <para>A DB cluster identifier to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterSnapshotCmdlet.DBClusterSnapshotIdentifier"> <summary> <para> <para>A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li><li>If this is the identifier of an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterSnapshotCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterSnapshotCmdlet.SnapshotType"> <summary> <para> <para>The type of DB cluster snapshots that will be returned. Values can be <code>automated</code> or <code>manual</code>. If this parameter is not specified, the returned results will include all snapshot types. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterSnapshotCmdlet.Marker"> <summary> <para> <para>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBClusterSnapshotCmdlet.MaxRecord"> <summary> <para> <para>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet"> <summary> Returns a list of the available DB engines. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet.DBParameterGroupFamily"> <summary> <para> <para> The name of a specific DB parameter group family to return details for. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet.DefaultOnly"> <summary> <para> <para> Indicates that only the default version of the specified engine or engine and major version combination is returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet.Engine"> <summary> <para> <para> The database engine to return. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet.EngineVersion"> <summary> <para> <para> The database engine version to return. </para><para>Example: <code>5.1.49</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet.Filter"> <summary> <para> <para> Not currently supported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet.ListSupportedCharacterSet"> <summary> <para> <para> If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBEngineVersionCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBInstanceCmdlet"> <summary> Returns information about provisioned RDS instances. This API supports pagination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBInstanceCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBInstanceCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBInstanceCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBInstanceCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilePortionCmdlet"> <summary> Downloads all or a portion of the specified log file, up to 1 MB in size. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilePortionCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The customer-assigned name of the DB instance that contains the log files you want to list. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilePortionCmdlet.LogFileName"> <summary> <para> <para> The name of the log file to be downloaded. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilePortionCmdlet.NumberOfLines"> <summary> <para> <para> The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size. </para><para>If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter. <ul><li><para>If neither Marker or NumberOfLines are specified, the entire log file is returned.</para></li><li><para>If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.</para></li><li><para>If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.</para></li><li><para>You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.</para></li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilePortionCmdlet.Marker"> <summary> <para> <para> The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilesCmdlet"> <summary> Returns a list of DB log files for the DB instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilesCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The customer-assigned name of the DB instance that contains the log files you want to list. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilesCmdlet.FileLastWritten"> <summary> <para> <para> Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilesCmdlet.FilenameContains"> <summary> <para> <para> Filters the available log files for log file names that contain the specified string. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilesCmdlet.FileSize"> <summary> <para> <para> Filters the available log files for files larger than the specified size. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilesCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilesCmdlet.Marker"> <summary> <para> <para> The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBLogFilesCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterCmdlet"> <summary> Returns the detailed parameter list for a particular DB parameter group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterCmdlet.DBParameterGroupName"> <summary> <para> <para> The name of a specific DB parameter group to return details for. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterCmdlet.Source"> <summary> <para> <para> The parameter types to return. </para><para>Default: All parameter types returned</para><para>Valid Values: <code>user | system | engine-default</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeDBParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterGroupCmdlet"> <summary> Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterGroupCmdlet.DBParameterGroupName"> <summary> <para> <para> The name of a specific DB parameter group to return details for. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterGroupCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterGroupCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeDBParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBParameterGroupCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSecurityGroupCmdlet"> <summary> Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSecurityGroupCmdlet.DBSecurityGroupName"> <summary> <para> <para> The name of the DB security group to return details for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSecurityGroupCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSecurityGroupCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeDBSecurityGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSecurityGroupCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSnapshotCmdlet"> <summary> Returns information about DB snapshots. This API supports pagination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSnapshotCmdlet.DBInstanceIdentifier"> <summary> <para> <para> A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with <code>DBSnapshotIdentifier</code>. This parameter is not case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSnapshotCmdlet.DBSnapshotIdentifier"> <summary> <para> <para> A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with <code>DBInstanceIdentifier</code>. This value is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li><li>If this is the identifier of an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSnapshotCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSnapshotCmdlet.SnapshotType"> <summary> <para> <para> The type of snapshots that will be returned. Values can be "automated" or "manual." If not specified, the returned results will include all snapshots types. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSnapshotCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeDBSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSnapshotCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSubnetGroupCmdlet"> <summary> Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. <para> For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSubnetGroupCmdlet.DBSubnetGroupName"> <summary> <para> <para> The name of the DB subnet group to return details for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSubnetGroupCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSubnetGroupCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSDBSubnetGroupCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultClusterParameterCmdlet"> <summary> Returns the default engine and system parameter information for the cluster database engine. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultClusterParameterCmdlet.DBParameterGroupFamily"> <summary> <para> <para> The name of the DB cluster parameter group family to return engine parameter information for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultClusterParameterCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultClusterParameterCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeEngineDefaultClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultClusterParameterCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultParameterCmdlet"> <summary> Returns the default engine and system parameter information for the specified database engine. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultParameterCmdlet.DBParameterGroupFamily"> <summary> <para> <para> The name of the DB parameter group family. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultParameterCmdlet.Filter"> <summary> <para> <para> Not currently supported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultParameterCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribeEngineDefaultParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEngineDefaultParameterCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet"> <summary> Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.Duration"> <summary> <para> <para> The number of minutes to retrieve events for. </para><para>Default: 60</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.EndTime"> <summary> <para> <para> The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></para><para>Example: 2009-07-08T18:00Z</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.EventCategory"> <summary> <para> <para> A list of event categories that trigger notifications for a event notification subscription. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.SourceIdentifier"> <summary> <para> <para> The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response. </para><para>Constraints:</para><ul><li>If SourceIdentifier is supplied, SourceType must also be provided.</li><li>If the source type is <code>DBInstance</code>, then a <code>DBInstanceIdentifier</code> must be supplied.</li><li>If the source type is <code>DBSecurityGroup</code>, a <code>DBSecurityGroupName</code> must be supplied.</li><li>If the source type is <code>DBParameterGroup</code>, a <code>DBParameterGroupName</code> must be supplied.</li><li>If the source type is <code>DBSnapshot</code>, a <code>DBSnapshotIdentifier</code> must be supplied.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.SourceType"> <summary> <para> <para> The event source to retrieve events for. If no value is specified, all events are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.StartTime"> <summary> <para> <para> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></para><para>Example: 2009-07-08T18:00Z</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCategoriesCmdlet"> <summary> Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html"> Events</a> topic in the <i>Amazon RDS User Guide.</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCategoriesCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventCategoriesCmdlet.SourceType"> <summary> <para> <para> The type of source that will be generating the events. </para><para>Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventSubscriptionsCmdlet"> <summary> Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. <para> If you specify a SubscriptionName, lists the description for that subscription. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventSubscriptionsCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventSubscriptionsCmdlet.SubscriptionName"> <summary> <para> <para>The name of the RDS event notification subscription you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventSubscriptionsCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSEventSubscriptionsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupCmdlet"> <summary> Describes the available option groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupCmdlet.EngineName"> <summary> <para> <para> Filters the list of option groups to only include groups associated with a specific database engine. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupCmdlet.MajorEngineVersion"> <summary> <para> <para> Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupCmdlet.OptionGroupName"> <summary> <para> <para> The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupOptionCmdlet"> <summary> Describes all available options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupOptionCmdlet.EngineName"> <summary> <para> <para> A required parameter. Options available for the given engine name will be described. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupOptionCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupOptionCmdlet.MajorEngineVersion"> <summary> <para> <para> If specified, filters the results to include only options for the specified major engine version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupOptionCmdlet.Marker"> <summary> <para> <para>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOptionGroupOptionCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet"> <summary> Returns a list of orderable DB instance options for the specified engine. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet.DBInstanceClass"> <summary> <para> <para> The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet.Engine"> <summary> <para> <para> The name of the engine to retrieve DB instance options for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet.EngineVersion"> <summary> <para> <para> The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet.LicenseModel"> <summary> <para> <para> The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet.Vpc"> <summary> <para> <para> The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSOrderableDBInstanceOptionCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSPendingMaintenanceActionsCmdlet"> <summary> Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSPendingMaintenanceActionsCmdlet.Filter"> <summary> <para> <para>A filter that specifies one or more resources to return pending maintenance actions for.</para><para>Supported filters:</para><ul><li><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB instances identified by these ARNs.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSPendingMaintenanceActionsCmdlet.ResourceIdentifier"> <summary> <para> <para>The ARN of a resource to return pending maintenance actions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSPendingMaintenanceActionsCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSPendingMaintenanceActionsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet"> <summary> Returns information about reserved DB instances for this account, or about a specified reserved DB instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.DBInstanceClass"> <summary> <para> <para> The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.Duration"> <summary> <para> <para> The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. </para><para>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.MultiAZ"> <summary> <para> <para> The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.OfferingType"> <summary> <para> <para> The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. </para><para>Valid Values: <code>"Partial Upfront" | "All Upfront" | "No Upfront" </code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.ProductDescription"> <summary> <para> <para> The product description filter value. Specify this parameter to show only those reservations matching the specified product description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.ReservedDBInstanceId"> <summary> <para> <para> The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.ReservedDBInstancesOfferingId"> <summary> <para> <para> The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstanceCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingCmdlet"> <summary> Purchases a reserved DB instance offering. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingCmdlet.DBInstanceCount"> <summary> <para> <para> The number of instances to reserve. </para><para>Default: <code>1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingCmdlet.ReservedDBInstanceId"> <summary> <para> <para> Customer-specified identifier to track this reservation. </para><para>Example: myreservationID</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingCmdlet.ReservedDBInstancesOfferingId"> <summary> <para> <para> The ID of the Reserved DB instance offering to purchase. </para><para>Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet"> <summary> Lists available reserved DB instance offerings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.DBInstanceClass"> <summary> <para> <para> The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.Duration"> <summary> <para> <para> Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. </para><para>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.MultiAZ"> <summary> <para> <para> The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.OfferingType"> <summary> <para> <para> The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. </para><para>Valid Values: <code>"Partial Upfront" | "All Upfront" | "No Upfront" </code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.ProductDescription"> <summary> <para> <para> Product description filter value. Specify this parameter to show only the available offerings matching the specified product description. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.ReservedDBInstancesOfferingId"> <summary> <para> <para> The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. </para><para>Example: <code>438012d3-4052-4cc7-b2e3-8d3372e0e706</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.Marker"> <summary> <para> <para> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSReservedDBInstancesOfferingsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. </para><para>Default: 100</para><para>Constraints: Minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.GetRDSTagForResourceCmdlet"> <summary> Lists all tags on an Amazon RDS resource. <para> For an overview on tagging an Amazon RDS resource, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSTagForResourceCmdlet.Filter"> <summary> <para> <para>This parameter is not currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.GetRDSTagForResourceCmdlet.ResourceName"> <summary> <para> <para>The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"> Constructing an RDS Amazon Resource Name (ARN)</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet"> <summary> Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.AvailabilityZone"> <summary> <para> <para>A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions and Availability Zones</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.BackupRetentionPeriod"> <summary> <para> <para>The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. </para><para>Default: 1 </para><para>Constraints:</para><ul><li>Must be a value from 0 to 35</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.CharacterSetName"> <summary> <para> <para>A value that indicates that the DB cluster should be associated with the specified CharacterSet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.DatabaseName"> <summary> <para> <para>The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.DBClusterIdentifier"> <summary> <para> <para>The DB cluster identifier. This parameter is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul><para>Example: <code>my-cluster1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.DBClusterParameterGroupName"> <summary> <para> <para> The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, <code>default.aurora5.6</code> for the specified engine will be used. </para><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.DBSubnetGroupName"> <summary> <para> <para>A DB subnet group to associate with this DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.Engine"> <summary> <para> <para>The name of the database engine to be used for this DB cluster. </para><para>Valid Values: <code>aurora</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.EngineVersion"> <summary> <para> <para>The version number of the database engine to use. </para><para><b>Aurora</b></para><para>Example: <code>5.6.10a</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.MasterUsername"> <summary> <para> <para> The name of the master user for the client DB cluster. </para><para>Constraints:</para><ul><li>Must be 1 to 16 alphanumeric characters.</li><li>First character must be a letter.</li><li>Cannot be a reserved word for the chosen database engine.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.MasterUserPassword"> <summary> <para> <para>The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". </para><para>Constraints: Must contain from 8 to 41 characters. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.OptionGroupName"> <summary> <para> <para>A value that indicates that the DB cluster should be associated with the specified option group. </para><para>Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.Port"> <summary> <para> <para> The port number on which the instances in the DB cluster accept connections. </para><para> Default: <code>3306</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.PreferredBackupWindow"> <summary> <para> <para>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. </para><para>Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i></para><para>Constraints:</para><ul><li>Must be in the format <code>hh24:mi-hh24:mi</code>.</li><li>Times should be in Universal Coordinated Time (UTC).</li><li>Must not conflict with the preferred maintenance window.</li><li>Must be at least 30 minutes.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). </para><para> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></para><para>Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i></para><para>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</para><para>Constraints: Minimum 30-minute window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.VpcSecurityGroupId"> <summary> <para> <para>A list of EC2 VPC security groups to associate with this DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterCmdlet.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.RDS.NewRDSDBClusterParameterGroupCmdlet"> <summary> Creates a new DB cluster parameter group. <para> Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. </para><para> A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using <a>ModifyDBClusterParameterGroup</a>. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using <a>ModifyDBCluster</a>. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. </para><important><para> After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified. </para></important><para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterParameterGroupCmdlet.DBClusterParameterGroupName"> <summary> <para> <para> The name of the DB cluster parameter group. </para><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><note>This value is stored as a lowercase string.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterParameterGroupCmdlet.DBParameterGroupFamily"> <summary> <para> <para> The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterParameterGroupCmdlet.Description"> <summary> <para> <para> The description for the DB cluster parameter group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterParameterGroupCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterParameterGroupCmdlet.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.RDS.NewRDSDBClusterSnapshotCmdlet"> <summary> Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterSnapshotCmdlet.DBClusterIdentifier"> <summary> <para> <para>The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul><para>Example: <code>my-cluster1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterSnapshotCmdlet.DBClusterSnapshotIdentifier"> <summary> <para> <para>The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul><para>Example: <code>my-cluster1-snapshot1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterSnapshotCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the DB cluster snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBClusterSnapshotCmdlet.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.RDS.NewRDSDBInstanceCmdlet"> <summary> Creates a new DB instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.AllocatedStorage"> <summary> <para> <para> The amount of storage (in gigabytes) to be initially allocated for the database instance. </para><para> Type: Integer</para><para><b>MySQL</b></para><para> Constraints: Must be an integer from 5 to 6144.</para><para><b>PostgreSQL</b></para><para> Constraints: Must be an integer from 5 to 6144.</para><para><b>Oracle</b></para><para> Constraints: Must be an integer from 10 to 6144.</para><para><b>SQL Server</b></para><para> Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para> Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. </para><para>Default: <code>true</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.AvailabilityZone"> <summary> <para> <para> The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions and Availability Zones</a>. </para><para> Default: A random, system-chosen Availability Zone in the endpoint's region. </para><para> Example: <code>us-east-1d</code></para><para> Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to <code>true</code>. The specified Availability Zone must be in the same region as the current endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.BackupRetentionPeriod"> <summary> <para> <para> The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. </para><para> Default: 1 </para><para>Constraints:</para><ul><li>Must be a value from 0 to 35</li><li>Cannot be set to 0 if the DB instance is a source to Read Replicas</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.CharacterSetName"> <summary> <para> <para> For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.CopyTagsToSnapshot"> <summary> <para> <para>True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.DBClusterIdentifier"> <summary> <para> <para>The identifier of the DB cluster that the instance will belong to.</para><para>For information on creating a DB cluster, see <a>CreateDBCluster</a>.</para><para>Type: String</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.DBInstanceClass"> <summary> <para> <para> The compute and memory capacity of the DB instance. </para><para> Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The DB instance identifier. This parameter is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul><para>Example: <code>mydbinstance</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.DBName"> <summary> <para> <para>The meaning of this parameter differs according to the database engine you use.</para><para>Type: String</para><para><b>MySQL</b></para><para>The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. </para><para>Constraints:</para><ul><li>Must contain 1 to 64 alphanumeric characters</li><li>Cannot be a word reserved by the specified database engine</li></ul><para><b>PostgreSQL</b></para><para>The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance. </para><para>Constraints:</para><ul><li>Must contain 1 to 63 alphanumeric characters</li><li>Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).</li><li>Cannot be a word reserved by the specified database engine</li></ul><para><b>Oracle</b></para><para> The Oracle System ID (SID) of the created DB instance. </para><para>Default: <code>ORCL</code></para><para>Constraints:</para><ul><li>Cannot be longer than 8 characters</li></ul><para><b>SQL Server</b></para><para>Not applicable. Must be null.</para><para><b>Amazon Aurora</b></para><para>The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance. </para><para>Constraints:</para><ul><li>Must contain 1 to 64 alphanumeric characters</li><li>Cannot be a word reserved by the specified database engine</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.DBParameterGroupName"> <summary> <para> <para> The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used. </para><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.DBSecurityGroup"> <summary> <para> <para> A list of DB security groups to associate with this DB instance. </para><para> Default: The default DB security group for the database engine. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.DBSubnetGroupName"> <summary> <para> <para> A DB subnet group to associate with this DB instance. </para><para> If there is no DB subnet group, then it is a non-VPC DB instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.Engine"> <summary> <para> <para> The name of the database engine to be used for this instance. </para><para> Valid Values: <code>MySQL</code> | <code>oracle-se1</code> | <code>oracle-se</code> | <code>oracle-ee</code> | <code>sqlserver-ee</code> | <code>sqlserver-se</code> | <code>sqlserver-ex</code> | <code>sqlserver-web</code> | <code>postgres</code></para><para> Not every database engine is available for every AWS region. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.EngineVersion"> <summary> <para> <para> The version number of the database engine to use. </para><para> The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region. </para><para><b>MySQL</b></para><ul><li><b>Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):</b><code> 5.1.73a | 5.1.73b</code></li><li><b>Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):</b><code> 5.5.40 | 5.5.40a</code></li><li><b>Version 5.5 (Available in all regions):</b><code> 5.5.40b | 5.5.41 | 5.5.42</code></li><li><b>Version 5.6 (Available in all regions):</b><code> 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23</code></li></ul><para><b>Oracle Database Enterprise Edition (oracle-ee)</b></para><ul><li><b>Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):</b><code> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7</code></li><li><b>Version 11.2 (Available in all regions):</b><code> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4</code></li><li><b>Version 12.1 (Available in all regions):</b><code>12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1 </code></li></ul><para><b>Oracle Database Standard Edition (oracle-se)</b></para><ul><li><b>Version 11.2 (Only available in the following regions: us-west-1):</b><code> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7</code></li><li><b>Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):</b><code> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4</code></li><li><b>Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):</b><code>12.1.0.1.v1 | 12.1.0.1.v2</code></li></ul><para><b>Oracle Database Standard Edition One (oracle-se1)</b></para><ul><li><b>Version 11.2 (Only available in the following regions: us-west-1):</b><code> 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7</code></li><li><b>Version 11.2 (Only available in the following regions: eu-central-1, us-west-1):</b><code> 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4</code></li><li><b>Version 12.1 (Only available in the following regions: eu-central-1, us-west-1):</b><code> 12.1.0.1.v1 | 12.1.0.1.v2</code></li></ul><para><b>PostgreSQL</b></para><ul><li><b>Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):</b><code> 9.3.1 | 9.3.2</code></li><li><b>Version 9.3 (Available in all regions):</b><code> 9.3.3 | 9.3.5 | 9.3.6</code></li><li><b>Version 9.4 (Available in all regions):</b><code> 9.4.1</code></li></ul><para><b>Microsoft SQL Server Enterprise Edition (sqlserver-ee)</b></para><ul><li><b>Version 10.50 (Only available in the following regions: eu-central-1, us-west-1):</b><code> 10.50.2789.0.v1</code></li><li><b>Version 11.00 (Only available in the following regions: eu-central-1, us-west-1):</b><code> 11.00.2100.60.v1</code></li></ul><para><b>Microsoft SQL Server Express Edition (sqlserver-ex)</b></para><ul><li><b>Version 10.50 (Available in all regions):</b><code> 10.50.2789.0.v1</code></li><li><b>Version 11.00 (Available in all regions):</b><code> 11.00.2100.60.v1</code></li></ul><para><b>Microsoft SQL Server Standard Edition (sqlserver-se)</b></para><ul><li><b>Version 10.50 (Available in all regions):</b><code> 10.50.2789.0.v1</code></li><li><b>Version 11.00 (Available in all regions):</b><code> 11.00.2100.60.v1</code></li></ul><para><b>Microsoft SQL Server Web Edition (sqlserver-web)</b></para><ul><li><b>Version 10.50 (Available in all regions):</b><code> 10.50.2789.0.v1</code></li><li><b>Version 11.00 (Available in all regions):</b><code> 11.00.2100.60.v1</code></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.Iops"> <summary> <para> <para> The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. </para><para> Constraints: To use PIOPS, this value must be an integer greater than 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.KmsKeyId"> <summary> <para> <para> The KMS key identifier for an encrypted DB instance. </para><para>The KMS key identifier is the Amazon Resoure Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.</para><para>If the <code>StorageEncrypted</code> parameter is true, and you do not specify a value for the <code>KmsKeyId</code> parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.LicenseModel"> <summary> <para> <para> License model information for this DB instance. </para><para> Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.MasterUsername"> <summary> <para> <para> The name of master user for the client DB instance. </para><para><b>MySQL</b></para><para>Constraints:</para><ul><li>Must be 1 to 16 alphanumeric characters.</li><li>First character must be a letter.</li><li>Cannot be a reserved word for the chosen database engine.</li></ul><para>Type: String</para><para><b>Oracle</b></para><para>Constraints:</para><ul><li>Must be 1 to 30 alphanumeric characters.</li><li>First character must be a letter.</li><li>Cannot be a reserved word for the chosen database engine.</li></ul><para><b>SQL Server</b></para><para>Constraints:</para><ul><li>Must be 1 to 128 alphanumeric characters.</li><li>First character must be a letter.</li><li>Cannot be a reserved word for the chosen database engine.</li></ul><para><b>PostgreSQL</b></para><para>Constraints:</para><ul><li>Must be 1 to 63 alphanumeric characters.</li><li>First character must be a letter.</li><li>Cannot be a reserved word for the chosen database engine.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.MasterUserPassword"> <summary> <para> <para> The password for the master database user. Can be any printable ASCII character except "/", """, or "@". </para><para>Type: String</para><para><b>MySQL</b></para><para> Constraints: Must contain from 8 to 41 characters. </para><para><b>Oracle</b></para><para> Constraints: Must contain from 8 to 30 characters. </para><para><b>SQL Server</b></para><para> Constraints: Must contain from 8 to 128 characters. </para><para><b>PostgreSQL</b></para><para> Constraints: Must contain from 8 to 128 characters. </para><para><b>Amazon Aurora</b></para><para> Constraints: Must contain from 8 to 41 characters. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.MultiAZ"> <summary> <para> <para> Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.OptionGroupName"> <summary> <para> <para> Indicates that the DB instance should be associated with the specified option group. </para><para> Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.Port"> <summary> <para> <para> The port number on which the database accepts connections. </para><para><b>MySQL</b></para><para> Default: <code>3306</code></para><para> Valid Values: <code>1150-65535</code></para><para>Type: Integer </para><para><b>PostgreSQL</b></para><para> Default: <code>5432</code></para><para> Valid Values: <code>1150-65535</code></para><para>Type: Integer </para><para><b>Oracle</b></para><para> Default: <code>1521</code></para><para> Valid Values: <code>1150-65535</code></para><para><b>SQL Server</b></para><para> Default: <code>1433</code></para><para> Valid Values: <code>1150-65535</code> except for <code>1434</code>, <code>3389</code>, <code>47001</code>, <code>49152</code>, and <code>49152</code> through <code>49156</code>. </para><para><b>Amazon Aurora</b></para><para> Default: <code>3306</code></para><para> Valid Values: <code>1150-65535</code></para><para>Type: Integer </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.PreferredBackupWindow"> <summary> <para> <para> The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.BackingUpAndRestoringAmazonRDSInstances.html">DB Instance Backups</a>. </para><para> Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i></para><para>Constraints: </para><ul><li>Must be in the format <code>hh24:mi-hh24:mi</code>.</li><li>Times should be in Universal Coordinated Time (UTC).</li><li>Must not conflict with the preferred maintenance window.</li><li>Must be at least 30 minutes.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para> The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBMaintenance.html">DB Instance Maintenance</a>. </para><para> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></para><para> Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i></para><para>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</para><para>Constraints: Minimum 30-minute window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.PubliclyAccessible"> <summary> <para> <para> Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. </para><para> Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. </para><ul><li><b>Default VPC:</b> true</li><li><b>VPC:</b> false</li></ul><para> If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.StorageEncrypted"> <summary> <para> <para> Specifies whether the DB instance is encrypted. </para><para> Default: false </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.StorageType"> <summary> <para> <para> Specifies the storage type to be associated with the DB instance. </para><para> Valid values: <code>standard | gp2 | io1</code></para><para> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </para><para> Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.TdeCredentialArn"> <summary> <para> <para> The ARN from the Key Store with which to associate the instance for TDE encryption. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.TdeCredentialPassword"> <summary> <para> <para> The password for the given ARN from the Key Store in order to access the device. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.VpcSecurityGroupId"> <summary> <para> <para> A list of EC2 VPC security groups to associate with this DB instance. </para><para> Default: The default EC2 VPC security group for the DB subnet group's VPC. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceCmdlet.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.RDS.NewRDSDBInstanceReadReplicaCmdlet"> <summary> Creates a DB instance for a DB instance running MySQL or PostgreSQL that acts as a Read Replica of a source DB instance. <para> All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below. </para><important><para> The source DB instance must have backup retention enabled. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para> Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. </para><para>Default: Inherits from the source DB instance</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.AvailabilityZone"> <summary> <para> <para> The Amazon EC2 Availability Zone that the Read Replica will be created in. </para><para> Default: A random, system-chosen Availability Zone in the endpoint's region. </para><para> Example: <code>us-east-1d</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.CopyTagsToSnapshot"> <summary> <para> <para>True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.DBInstanceClass"> <summary> <para> <para> The compute and memory capacity of the Read Replica. </para><para> Valid Values: <code>db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code></para><para>Default: Inherits from the source DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.DBSubnetGroupName"> <summary> <para> <para> Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC. </para><para>Constraints:</para><ul><li>Can only be specified if the source DB instance identifier specifies a DB instance in another region.</li><li>The specified DB subnet group must be in the same region in which the operation is running.</li><li> All Read Replicas in one region that are created from the same source DB instance must either: <ul><li>Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.</li><li>Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.</li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.Iops"> <summary> <para> <para> The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.OptionGroupName"> <summary> <para> <para> The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.Port"> <summary> <para> <para> The port number that the DB instance uses for connections. </para><para>Default: Inherits from the source DB instance</para><para>Valid Values: <code>1150-65535</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.PubliclyAccessible"> <summary> <para> <para> Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. </para><para> Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. </para><ul><li><b>Default VPC:</b>true</li><li><b>VPC:</b>false</li></ul><para> If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.SourceDBInstanceIdentifier"> <summary> <para> <para> The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas. </para><para>Constraints:</para><ul><li>Must be the identifier of an existing DB instance.</li><li>Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.</li><li>Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.</li><li>The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.</li><li>If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.</li><li>If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"> Constructing a Amazon RDS Amazon Resource Name (ARN)</a>.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.StorageType"> <summary> <para> <para> Specifies the storage type to be associated with the Read Replica. </para><para> Valid values: <code>standard | gp2 | io1</code></para><para> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </para><para> Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBInstanceReadReplicaCmdlet.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.RDS.NewRDSDBParameterGroupCmdlet"> <summary> Creates a new DB parameter group. <para> A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <i>ModifyDBParameterGroup</i>. Once you've created a DB parameter group, you need to associate it with your DB instance using <i>ModifyDBInstance</i>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. </para><important><para> After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBParameterGroupCmdlet.DBParameterGroupFamily"> <summary> <para> <para> The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBParameterGroupCmdlet.DBParameterGroupName"> <summary> <para> <para> The name of the DB parameter group. </para><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><note>This value is stored as a lowercase string.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBParameterGroupCmdlet.Description"> <summary> <para> <para> The description for the DB parameter group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBParameterGroupCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBParameterGroupCmdlet.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.RDS.NewRDSDBSecurityGroupCmdlet"> <summary> Creates a new DB security group. DB security groups control access to a DB instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSecurityGroupCmdlet.DBSecurityGroupDescription"> <summary> <para> <para> The description for the DB security group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSecurityGroupCmdlet.DBSecurityGroupName"> <summary> <para> <para> The name for the DB security group. This value is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li><li>Must not be "Default"</li><li>Cannot contain spaces</li></ul><para>Example: <code>mysecuritygroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSecurityGroupCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSecurityGroupCmdlet.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.RDS.NewRDSDBSnapshotCmdlet"> <summary> Creates a DBSnapshot. The source DBInstance must be in "available" state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSnapshotCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The DB instance identifier. This is the unique key that identifies a DB instance. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSnapshotCmdlet.DBSnapshotIdentifier"> <summary> <para> <para> The identifier for the DB snapshot. </para><para>Constraints:</para><ul><li>Cannot be null, empty, or blank</li><li>Must contain from 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>my-snapshot-id</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSnapshotCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSnapshotCmdlet.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.RDS.NewRDSDBSubnetGroupCmdlet"> <summary> Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSubnetGroupCmdlet.DBSubnetGroupDescription"> <summary> <para> <para> The description for the DB subnet group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSubnetGroupCmdlet.DBSubnetGroupName"> <summary> <para> <para> The name for the DB subnet group. This value is stored as a lowercase string. </para><para>Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, or hyphens. Must not be default.</para><para>Example: <code>mySubnetgroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSubnetGroupCmdlet.SubnetId"> <summary> <para> <para> The EC2 Subnet IDs for the DB subnet group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSubnetGroupCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSDBSubnetGroupCmdlet.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.RDS.NewRDSEventSubscriptionCmdlet"> <summary> Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. <para> You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. </para><para> If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSEventSubscriptionCmdlet.Enabled"> <summary> <para> <para> A Boolean value; set to <b>true</b> to activate the subscription, set to <b>false</b> to create the subscription but not active it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSEventSubscriptionCmdlet.EventCategory"> <summary> <para> <para> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> topic in the Amazon RDS User Guide or by using the <b>DescribeEventCategories</b> action. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSEventSubscriptionCmdlet.SnsTopicArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSEventSubscriptionCmdlet.SourceId"> <summary> <para> <para> The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. </para><para>Constraints:</para><ul><li>If SourceIds are supplied, SourceType must also be provided.</li><li>If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied.</li><li>If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied.</li><li>If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied.</li><li>If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSEventSubscriptionCmdlet.SourceType"> <summary> <para> <para> The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. </para><para>Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the subscription. </para><para>Constraints: The name must be less than 255 characters. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSEventSubscriptionCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSEventSubscriptionCmdlet.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.RDS.NewRDSOptionGroupCmdlet"> <summary> Creates a new option group. You can create up to 20 option groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSOptionGroupCmdlet.EngineName"> <summary> <para> <para> Specifies the name of the engine that this option group should be associated with. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSOptionGroupCmdlet.MajorEngineVersion"> <summary> <para> <para> Specifies the major version of the engine that this option group should be associated with. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSOptionGroupCmdlet.OptionGroupDescription"> <summary> <para> <para> The description of the option group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSOptionGroupCmdlet.OptionGroupName"> <summary> <para> <para> Specifies the name of the option group to be created. </para><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>myoptiongroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSOptionGroupCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.NewRDSOptionGroupCmdlet.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.RDS.RemoveRDSDBClusterCmdlet"> <summary> The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterCmdlet.DBClusterIdentifier"> <summary> <para> <para>The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterCmdlet.FinalDBSnapshotIdentifier"> <summary> <para> <para> The DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is set to <code>false</code>. </para><note> Specifying this parameter and also setting the <code>SkipFinalShapshot</code> parameter to true results in an error. </note><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterCmdlet.SkipFinalSnapshot"> <summary> <para> <para> Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If <code>true</code> is specified, no DB cluster snapshot is created. If <code>false</code> is specified, a DB cluster snapshot is created before the DB cluster is deleted. </para><note>You must specify a <code>FinalDBSnapshotIdentifier</code> parameter if <code>SkipFinalSnapshot</code> is <code>false</code>.</note><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterCmdlet.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.RDS.RemoveRDSDBClusterParameterGroupCmdlet"> <summary> Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterParameterGroupCmdlet.DBClusterParameterGroupName"> <summary> <para> <para> The name of the DB cluster parameter group. </para><para>Constraints:</para><ul><li>Must be the name of an existing DB cluster parameter group.</li><li>You cannot delete a default DB cluster parameter group.</li><li>Cannot be associated with any DB clusters.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterParameterGroupCmdlet.PassThru"> <summary> Returns the value passed to the DBClusterParameterGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterParameterGroupCmdlet.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.RDS.RemoveRDSDBClusterSnapshotCmdlet"> <summary> Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. <note>The DB cluster snapshot must be in the <code>available</code> state to be deleted.</note><para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterSnapshotCmdlet.DBClusterSnapshotIdentifier"> <summary> <para> <para>The identifier of the DB cluster snapshot to delete. </para><para>Constraints: Must be the name of an existing DB cluster snapshot in the <code>available</code> state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBClusterSnapshotCmdlet.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.RDS.RemoveRDSDBInstanceCmdlet"> <summary> The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted. <para> If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted. </para><para> Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBInstanceCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBInstanceCmdlet.FinalDBSnapshotIdentifier"> <summary> <para> <para> The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to <code>false</code>. </para><note> Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. </note><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li><li>Cannot be specified when deleting a Read Replica.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBInstanceCmdlet.SkipFinalSnapshot"> <summary> <para> <para> Determines whether a final DB snapshot is created before the DB instance is deleted. If <code>true</code> is specified, no DBSnapshot is created. If <code>false</code> is specified, a DB snapshot is created before the DB instance is deleted. </para><para>Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".</para><para>Specify <code>true</code> when deleting a Read Replica.</para><note>The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is <code>false</code>.</note><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBInstanceCmdlet.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.RDS.RemoveRDSDBParameterGroupCmdlet"> <summary> Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBParameterGroupCmdlet.DBParameterGroupName"> <summary> <para> <para> The name of the DB parameter group. </para><para>Constraints:</para><ul><li>Must be the name of an existing DB parameter group</li><li>You cannot delete a default DB parameter group</li><li>Cannot be associated with any DB instances</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBParameterGroupCmdlet.PassThru"> <summary> Returns the value passed to the DBParameterGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBParameterGroupCmdlet.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.RDS.RemoveRDSDBSecurityGroupCmdlet"> <summary> Deletes a DB security group. <note>The specified DB security group must not be associated with any DB instances.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBSecurityGroupCmdlet.DBSecurityGroupName"> <summary> <para> <para> The name of the DB security group to delete. </para><note>You cannot delete the default DB security group.</note><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li><li>Must not be "Default"</li><li>Cannot contain spaces</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBSecurityGroupCmdlet.PassThru"> <summary> Returns the value passed to the DBSecurityGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBSecurityGroupCmdlet.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.RDS.RemoveRDSDBSnapshotCmdlet"> <summary> Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated. <note>The DBSnapshot must be in the <code>available</code> state to be deleted.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBSnapshotCmdlet.DBSnapshotIdentifier"> <summary> <para> <para> The DBSnapshot identifier. </para><para>Constraints: Must be the name of an existing DB snapshot in the <code>available</code> state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBSnapshotCmdlet.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.RDS.RemoveRDSDBSubnetGroupCmdlet"> <summary> Deletes a DB subnet group. <note>The specified database subnet group must not be associated with any DB instances.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBSubnetGroupCmdlet.DBSubnetGroupName"> <summary> <para> <para> The name of the database subnet group to delete. </para><note>You cannot delete the default subnet group.</note><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBSubnetGroupCmdlet.PassThru"> <summary> Returns the value passed to the DBSubnetGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSDBSubnetGroupCmdlet.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.RDS.RemoveRDSEventSubscriptionCmdlet"> <summary> Deletes an RDS event notification subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the RDS event notification subscription you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSEventSubscriptionCmdlet.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.RDS.RemoveRDSOptionGroupCmdlet"> <summary> Deletes an existing option group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSOptionGroupCmdlet.OptionGroupName"> <summary> <para> <para> The name of the option group to be deleted. </para><note>You cannot delete default option groups.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSOptionGroupCmdlet.PassThru"> <summary> Returns the value passed to the OptionGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSOptionGroupCmdlet.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.RDS.RemoveRDSSourceIdentifierFromSubscriptionCmdlet"> <summary> Removes a source identifier from an existing RDS event notification subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSSourceIdentifierFromSubscriptionCmdlet.SourceIdentifier"> <summary> <para> <para> The source identifier to be removed from the subscription, such as the <b>DB instance identifier</b> for a DB instance or the name of a security group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSSourceIdentifierFromSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the RDS event notification subscription you want to remove a source identifier from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSSourceIdentifierFromSubscriptionCmdlet.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.RDS.RemoveRDSTagFromResourceCmdlet"> <summary> Removes metadata tags from an Amazon RDS resource. <para> For an overview on tagging an Amazon RDS resource, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSTagFromResourceCmdlet.ResourceName"> <summary> <para> <para>The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"> Constructing an RDS Amazon Resource Name (ARN)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSTagFromResourceCmdlet.TagKey"> <summary> <para> <para>The tag key (name) of the tag to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSTagFromResourceCmdlet.PassThru"> <summary> Returns the collection of tag keys that were removed. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RemoveRDSTagFromResourceCmdlet.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.RDS.ResetRDSDBClusterParameterGroupCmdlet"> <summary> Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. <para> When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <a>RebootDBInstance</a> request. You must call <a>RebootDBInstance</a> for every DB instance in your DB cluster that you want the updated static parameter to apply to. </para><para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ResetRDSDBClusterParameterGroupCmdlet.DBClusterParameterGroupName"> <summary> <para> <para>The name of the DB cluster parameter group to reset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ResetRDSDBClusterParameterGroupCmdlet.Parameter"> <summary> <para> <para>A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the <code>ResetAllParameters</code> parameter is set to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ResetRDSDBClusterParameterGroupCmdlet.ResetAllParameter"> <summary> <para> <para>A value that is set to <code>true</code> to reset all parameters in the DB cluster parameter group to their default values, and <code>false</code> otherwise. You cannot use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ResetRDSDBClusterParameterGroupCmdlet.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.RDS.ResetRDSDBParameterGroupCmdlet"> <summary> Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ResetRDSDBParameterGroupCmdlet.DBParameterGroupName"> <summary> <para> <para> The name of the DB parameter group. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ResetRDSDBParameterGroupCmdlet.Parameter"> <summary> <para> <para> An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. </para><para><b>MySQL</b></para><para>Valid Values (for Apply method): <code>immediate</code> | <code>pending-reboot</code></para><para>You can use the immediate value with dynamic parameters only. You can use the <code>pending-reboot</code> value for both dynamic and static parameters, and changes are applied when DB instance reboots.</para><para><b>Oracle</b></para><para>Valid Values (for Apply method): <code>pending-reboot</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ResetRDSDBParameterGroupCmdlet.ResetAllParameter"> <summary> <para> <para> Specifies whether (<code>true</code>) or not (<code>false</code>) to reset all parameters in the DB parameter group to default values. </para><para>Default: <code>true</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.ResetRDSDBParameterGroupCmdlet.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.RDS.RestartRDSDBInstanceCmdlet"> <summary> Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed. <para> If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs. </para><para> The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestartRDSDBInstanceCmdlet.DBInstanceIdentifier"> <summary> <para> <para> The DB instance identifier. This parameter is stored as a lowercase string. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestartRDSDBInstanceCmdlet.ForceFailover"> <summary> <para> <para> When <code>true</code>, the reboot will be conducted through a MultiAZ failover. </para><para>Constraint: You cannot specify <code>true</code> if the instance is not configured for MultiAZ.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestartRDSDBInstanceCmdlet.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.RDS.RestoreRDSDBClusterFromSnapshotCmdlet"> <summary> Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.AvailabilityZone"> <summary> <para> <para>Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.DatabaseName"> <summary> <para> <para>The database name for the restored DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.DBClusterIdentifier"> <summary> <para> <para>The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>my-snapshot-id</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.DBSubnetGroupName"> <summary> <para> <para>The name of the DB subnet group to use for the new DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.Engine"> <summary> <para> <para>The database engine to use for the new DB cluster. </para><para>Default: The same as source</para><para>Constraint: Must be compatible with the engine of the source</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.EngineVersion"> <summary> <para> <para>The version of the database engine to use for the new DB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.OptionGroupName"> <summary> <para> <para>The name of the option group to use for the restored DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.Port"> <summary> <para> <para> The port number on which the new DB cluster accepts connections. </para><para>Constraints: Value must be <code>1150-65535</code></para><para>Default: The same port as the original DB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.SnapshotIdentifier"> <summary> <para> <para>The identifier for the DB cluster snapshot to restore from. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the restored DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.VpcSecurityGroupId"> <summary> <para> <para> A list of VPC security groups that the new DB cluster will belong to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterFromSnapshotCmdlet.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.RDS.RestoreRDSDBClusterToPointInTimeCmdlet"> <summary> Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. <para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.DBClusterIdentifier"> <summary> <para> <para> The name of the new DB cluster to be created. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.DBSubnetGroupName"> <summary> <para> <para> The DB subnet group name to use for the new DB cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.OptionGroupName"> <summary> <para> <para>The name of the option group for the new DB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.Port"> <summary> <para> <para> The port number on which the new DB cluster accepts connections. </para><para>Constraints: Value must be <code>1150-65535</code></para><para>Default: The same port as the original DB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.RestoreToTime"> <summary> <para> <para> The date and time to restore the DB cluster to. </para><para>Valid Values: Value must be a time in Universal Coordinated Time (UTC) format</para><para>Constraints:</para><ul><li>Must be before the latest restorable time for the DB instance</li><li>Cannot be specified if <code>UseLatestRestorableTime</code> parameter is true</li></ul><para>Example: <code>2015-03-07T23:45:00Z</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.SourceDBClusterIdentifier"> <summary> <para> <para> The identifier of the source DB cluster from which to restore. </para><para>Constraints:</para><ul><li>Must be the identifier of an existing database instance</li><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.UseLatestRestorableTime"> <summary> <para> <para>A value that is set to <code>true</code> to restore the DB cluster to the latest restorable backup time, and <code>false</code> otherwise. </para><para>Default: <code>false</code></para><para>Constraints: Cannot be specified if <code>RestoreToTime</code> parameter is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.VpcSecurityGroupId"> <summary> <para> <para> A lst of VPC security groups that the new DB cluster belongs to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBClusterToPointInTimeCmdlet.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.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet"> <summary> Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. <para> If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para> Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.AvailabilityZone"> <summary> <para> <para> The EC2 Availability Zone that the database instance will be created in. </para><para>Default: A random, system-chosen Availability Zone.</para><para>Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>.</para><para>Example: <code>us-east-1a</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.CopyTagsToSnapshot"> <summary> <para> <para>True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.DBInstanceClass"> <summary> <para> <para> The compute and memory capacity of the Amazon RDS DB instance. </para><para>Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.DBInstanceIdentifier"> <summary> <para> <para> Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>my-snapshot-id</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.DBName"> <summary> <para> <para> The database name for the restored DB instance. </para><note><para>This parameter doesn't apply to the MySQL engine.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.DBSnapshotIdentifier"> <summary> <para> <para> The identifier for the DB snapshot to restore from. </para><para>Constraints:</para><ul><li>Must contain from 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.DBSubnetGroupName"> <summary> <para> <para> The DB subnet group name to use for the new instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.Engine"> <summary> <para> <para> The database engine to use for the new instance. </para><para>Default: The same as source</para><para>Constraint: Must be compatible with the engine of the source</para><para> Valid Values: <code>MySQL</code> | <code>oracle-se1</code> | <code>oracle-se</code> | <code>oracle-ee</code> | <code>sqlserver-ee</code> | <code>sqlserver-se</code> | <code>sqlserver-ex</code> | <code>sqlserver-web</code> | <code>postgres</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.Iops"> <summary> <para> <para> Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts. </para><para> Constraints: Must be an integer greater than 1000.</para><para><b>SQL Server</b></para><para>Setting the IOPS value for the SQL Server database engine is not supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.LicenseModel"> <summary> <para> <para> License model information for the restored DB instance. </para><para> Default: Same as source. </para><para> Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.MultiAZ"> <summary> <para> <para> Specifies if the DB instance is a Multi-AZ deployment. </para><para>Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.OptionGroupName"> <summary> <para> <para>The name of the option group to be used for the restored DB instance.</para><para>Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.Port"> <summary> <para> <para> The port number on which the database accepts connections. </para><para>Default: The same port as the original DB instance</para><para>Constraints: Value must be <code>1150-65535</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.PubliclyAccessible"> <summary> <para> <para> Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. </para><para> Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. </para><ul><li><b>Default VPC:</b> true</li><li><b>VPC:</b> false</li></ul><para> If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.StorageType"> <summary> <para> <para> Specifies the storage type to be associated with the DB instance. </para><para> Valid values: <code>standard | gp2 | io1</code></para><para> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </para><para> Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.TdeCredentialArn"> <summary> <para> <para> The ARN from the Key Store with which to associate the instance for TDE encryption. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.TdeCredentialPassword"> <summary> <para> <para> The password for the given ARN from the Key Store in order to access the device. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceFromDBSnapshotCmdlet.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.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet"> <summary> Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.AutoMinorVersionUpgrade"> <summary> <para> <para> Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.AvailabilityZone"> <summary> <para> <para> The EC2 Availability Zone that the database instance will be created in. </para><para>Default: A random, system-chosen Availability Zone.</para><para>Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.</para><para>Example: <code>us-east-1a</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.CopyTagsToSnapshot"> <summary> <para> <para>True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.DBInstanceClass"> <summary> <para> <para> The compute and memory capacity of the Amazon RDS DB instance. </para><para>Valid Values: <code>db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large</code></para><para>Default: The same DBInstanceClass as the original DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.DBName"> <summary> <para> <para> The database name for the restored DB instance. </para><note><para>This parameter is not used for the MySQL engine.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.DBSubnetGroupName"> <summary> <para> <para> The DB subnet group name to use for the new instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.Engine"> <summary> <para> <para> The database engine to use for the new instance. </para><para>Default: The same as source</para><para>Constraint: Must be compatible with the engine of the source</para><para> Valid Values: <code>MySQL</code> | <code>oracle-se1</code> | <code>oracle-se</code> | <code>oracle-ee</code> | <code>sqlserver-ee</code> | <code>sqlserver-se</code> | <code>sqlserver-ex</code> | <code>sqlserver-web</code> | <code>postgres</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.Iops"> <summary> <para> <para> The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. </para><para> Constraints: Must be an integer greater than 1000.</para><para><b>SQL Server</b></para><para>Setting the IOPS value for the SQL Server database engine is not supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.LicenseModel"> <summary> <para> <para> License model information for the restored DB instance. </para><para> Default: Same as source. </para><para> Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.MultiAZ"> <summary> <para> <para> Specifies if the DB instance is a Multi-AZ deployment. </para><para>Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.OptionGroupName"> <summary> <para> <para>The name of the option group to be used for the restored DB instance.</para><para>Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.Port"> <summary> <para> <para> The port number on which the database accepts connections. </para><para>Constraints: Value must be <code>1150-65535</code></para><para>Default: The same port as the original DB instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.PubliclyAccessible"> <summary> <para> <para> Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. </para><para> Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. </para><ul><li><b>Default VPC:</b>true</li><li><b>VPC:</b>false</li></ul><para> If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.RestoreTime"> <summary> <para> <para> The date and time to restore from. </para><para>Valid Values: Value must be a time in Universal Coordinated Time (UTC) format</para><para>Constraints:</para><ul><li>Must be before the latest restorable time for the DB instance</li><li>Cannot be specified if UseLatestRestorableTime parameter is true</li></ul><para>Example: <code>2009-09-07T23:45:00Z</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.SourceDBInstanceIdentifier"> <summary> <para> <para> The identifier of the source DB instance from which to restore. </para><para>Constraints:</para><ul><li>Must be the identifier of an existing database instance</li><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.StorageType"> <summary> <para> <para> Specifies the storage type to be associated with the DB instance. </para><para> Valid values: <code>standard | gp2 | io1</code></para><para> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </para><para> Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>standard</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.Tag"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.TargetDBInstanceIdentifier"> <summary> <para> <para> The name of the new database instance to be created. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.TdeCredentialArn"> <summary> <para> <para> The ARN from the Key Store with which to associate the instance for TDE encryption. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.TdeCredentialPassword"> <summary> <para> <para> The password for the given ARN from the Key Store in order to access the device. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.UseLatestRestorableTime"> <summary> <para> <para> Specifies whether (<code>true</code>) or not (<code>false</code>) the DB instance is restored from the latest backup time. </para><para>Default: <code>false</code></para><para>Constraints: Cannot be specified if RestoreTime parameter is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RestoreRDSDBInstanceToPointInTimeCmdlet.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.RDS.RevokeRDSDBSecurityGroupIngressCmdlet"> <summary> Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RevokeRDSDBSecurityGroupIngressCmdlet.CIDRIP"> <summary> <para> <para> The IP range to revoke access from. Must be a valid CIDR range. If <code>CIDRIP</code> is specified, <code>EC2SecurityGroupName</code>, <code>EC2SecurityGroupId</code> and <code>EC2SecurityGroupOwnerId</code> cannot be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RevokeRDSDBSecurityGroupIngressCmdlet.DBSecurityGroupName"> <summary> <para> <para> The name of the DB security group to revoke ingress from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RevokeRDSDBSecurityGroupIngressCmdlet.EC2SecurityGroupId"> <summary> <para> <para> The id of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RevokeRDSDBSecurityGroupIngressCmdlet.EC2SecurityGroupName"> <summary> <para> <para> The name of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RevokeRDSDBSecurityGroupIngressCmdlet.EC2SecurityGroupOwnerId"> <summary> <para> <para> The AWS Account Number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.RevokeRDSDBSecurityGroupIngressCmdlet.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.RDS.StartRDSDBClusterFailoverCmdlet"> <summary> Forces a failover for a DB cluster. <para> A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance. </para><para> Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. </para><para> For more information on Amazon Aurora, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html">Aurora on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.StartRDSDBClusterFailoverCmdlet.DBClusterIdentifier"> <summary> <para> <para>A DB cluster identifier to force a failover for. This parameter is not case-sensitive. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.StartRDSDBClusterFailoverCmdlet.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.RDS.SubmitRDSPendingMaintenanceActionCmdlet"> <summary> Applies a pending maintenance action to a resource (for example, to a DB instance). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.SubmitRDSPendingMaintenanceActionCmdlet.ApplyAction"> <summary> <para> <para>The pending maintenance action to apply to this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.SubmitRDSPendingMaintenanceActionCmdlet.OptInType"> <summary> <para> <para>A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type <code>immediate</code> cannot be undone.</para><para>Valid values:</para><ul><li><code>immediate</code> - Apply the maintenance action immediately.</li><li><code>next-maintenance</code> - Apply the maintenance action during the next maintenance window for the resource.</li><li><code>undo-opt-in</code> - Cancel any existing <code>next-maintenance</code> opt-in requests.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.SubmitRDSPendingMaintenanceActionCmdlet.ResourceIdentifier"> <summary> <para> <para>The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see <a href="http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"> Constructing an RDS Amazon Resource Name (ARN)</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RDS.SubmitRDSPendingMaintenanceActionCmdlet.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.RS.ApproveRSClusterSecurityGroupIngressCmdlet"> <summary> Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. <note> The EC2 security group must be defined in the AWS region where the cluster resides. </note><para> For an overview of CIDR blocks, see the Wikipedia article on <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. </para><para> You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Working with Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSClusterSecurityGroupIngressCmdlet.CIDRIP"> <summary> <para> <para> The IP range to be added the Amazon Redshift security group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSClusterSecurityGroupIngressCmdlet.ClusterSecurityGroupName"> <summary> <para> <para> The name of the security group to which the ingress rule is added. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSClusterSecurityGroupIngressCmdlet.EC2SecurityGroupName"> <summary> <para> <para> The EC2 security group to be added the Amazon Redshift security group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSClusterSecurityGroupIngressCmdlet.EC2SecurityGroupOwnerId"> <summary> <para> <para> The AWS account number of the owner of the security group specified by the <i>EC2SecurityGroupName</i> parameter. The AWS Access Key ID is not an acceptable value. </para><para> Example: <code>111122223333</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSClusterSecurityGroupIngressCmdlet.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.RS.ApproveRSSnapshotAccessCmdlet"> <summary> Authorizes the specified AWS customer account to restore the specified snapshot. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSSnapshotAccessCmdlet.AccountWithRestoreAccess"> <summary> <para> <para> The identifier of the AWS customer account authorized to restore the specified snapshot. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSSnapshotAccessCmdlet.SnapshotClusterIdentifier"> <summary> <para> <para> The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSSnapshotAccessCmdlet.SnapshotIdentifier"> <summary> <para> <para> The identifier of the snapshot the account is authorized to restore. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ApproveRSSnapshotAccessCmdlet.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.RS.CopyRSClusterSnapshotCmdlet"> <summary> Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. <para> When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. </para><para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.CopyRSClusterSnapshotCmdlet.SourceSnapshotClusterIdentifier"> <summary> <para> <para> The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </para><para>Constraints:</para><ul><li>Must be the identifier for a valid cluster.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.CopyRSClusterSnapshotCmdlet.SourceSnapshotIdentifier"> <summary> <para> <para> The identifier for the source snapshot. </para><para>Constraints:</para><ul><li>Must be the identifier for a valid automated snapshot whose state is <code>available</code>.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.CopyRSClusterSnapshotCmdlet.TargetSnapshotIdentifier"> <summary> <para> <para> The identifier given to the new manual snapshot. </para><para>Constraints:</para><ul><li>Cannot be null, empty, or blank.</li><li>Must contain from 1 to 255 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li><li>Must be unique for the AWS account that is making the request.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.CopyRSClusterSnapshotCmdlet.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.RS.DisableRSLoggingCmdlet"> <summary> Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.DisableRSLoggingCmdlet.ClusterIdentifier"> <summary> <para> <para> The identifier of the cluster on which logging is to be stopped. </para><para>Example: <code>examplecluster</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.DisableRSLoggingCmdlet.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.RS.DisableRSSnapshotCopyCmdlet"> <summary> Disables the automatic copying of snapshots from one region to another region for a specified cluster. <para> If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use <a>DeleteSnapshotCopyGrant</a> to delete the grant that grants Amazon Redshift permission to the CMK in the destination region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.DisableRSSnapshotCopyCmdlet.ClusterIdentifier"> <summary> <para> <para> The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. </para><para> Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.DisableRSSnapshotCopyCmdlet.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.RS.EditRSClusterCmdlet"> <summary> Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.AllowVersionUpgrade"> <summary> <para> <para> If <code>true</code>, major version upgrades will be applied automatically to the cluster during the maintenance window. </para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.AutomatedSnapshotRetentionPeriod"> <summary> <para> <para> The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </para><para> If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.</para><para>Default: Uses existing setting.</para><para>Constraints: Must be a value from 0 to 35.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.ClusterIdentifier"> <summary> <para> <para> The unique identifier of the cluster to be modified. </para><para>Example: <code>examplecluster</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.ClusterParameterGroupName"> <summary> <para> <para> The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use <a>RebootCluster</a>. </para><para>Default: Uses existing setting.</para><para>Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.ClusterSecurityGroup"> <summary> <para> <para> A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible. </para><para>Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.</para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.ClusterType"> <summary> <para> <para> The new cluster type. </para><para> When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use <a>DescribeResize</a> to track the progress of the resize request. </para><para>Valid Values: <code> multi-node | single-node </code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.ClusterVersion"> <summary> <para> <para> The new version number of the Amazon Redshift engine to upgrade to. </para><para> For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para><para>Example: <code>1.0</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.HsmClientCertificateIdentifier"> <summary> <para> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.HsmConfigurationIdentifier"> <summary> <para> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.MasterUserPassword"> <summary> <para> <para> The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. <note> Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost. </note></para><para>Default: Uses existing setting.</para><para> Constraints: </para><ul><li>Must be between 8 and 64 characters in length.</li><li>Must contain at least one uppercase letter.</li><li>Must contain at least one lowercase letter.</li><li>Must contain one number.</li><li>Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.NewClusterIdentifier"> <summary> <para> <para>The new identifier for the cluster.</para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>Alphabetic characters must be lowercase.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li><li>Must be unique for all clusters within an AWS account.</li></ul><para>Example: <code>examplecluster</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.NodeType"> <summary> <para> <para> The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter. </para><para> When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use <a>DescribeResize</a> to track the progress of the resize request. </para><para>Valid Values: <code> ds1.xlarge</code> | <code>ds1.8xlarge</code> | <code> ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.NumberOfNodes"> <summary> <para> <para> The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter. </para><para> When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use <a>DescribeResize</a> to track the progress of the resize request. </para><para>Valid Values: Integer greater than <code>0</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para> The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage. </para><para> This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied. </para><para>Default: Uses existing setting.</para><para>Format: ddd:hh24:mi-ddd:hh24:mi, for example <code>wed:07:30-wed:08:00</code>.</para><para>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</para><para>Constraints: Must be at least 30 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.VpcSecurityGroupId"> <summary> <para> <para> A list of virtual private cloud (VPC) security groups to be associated with the cluster. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterCmdlet.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.RS.EditRSClusterParameterGroupCmdlet"> <summary> Modifies the parameters of a parameter group. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterParameterGroupCmdlet.ParameterGroupName"> <summary> <para> <para> The name of the parameter group to be modified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterParameterGroupCmdlet.Parameter"> <summary> <para> <para> An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. </para><para> For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional. </para><para> For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterParameterGroupCmdlet.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.RS.EditRSClusterSubnetGroupCmdlet"> <summary> Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterSubnetGroupCmdlet.ClusterSubnetGroupName"> <summary> <para> <para>The name of the subnet group to be modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterSubnetGroupCmdlet.Description"> <summary> <para> <para>A text description of the subnet group to be modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterSubnetGroupCmdlet.SubnetId"> <summary> <para> <para> An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSClusterSubnetGroupCmdlet.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.RS.EditRSEventSubscriptionCmdlet"> <summary> Modifies an existing Amazon Redshift event notification subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSEventSubscriptionCmdlet.Enabled"> <summary> <para> <para> A Boolean value indicating if the subscription is enabled. <code>true</code> indicates the subscription is enabled </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSEventSubscriptionCmdlet.EventCategory"> <summary> <para> <para>Specifies the Amazon Redshift event categories to be published by the event notification subscription.</para><para>Values: Configuration, Management, Monitoring, Security</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSEventSubscriptionCmdlet.Severity"> <summary> <para> <para>Specifies the Amazon Redshift event severity to be published by the event notification subscription.</para><para>Values: ERROR, INFO</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSEventSubscriptionCmdlet.SnsTopicArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSEventSubscriptionCmdlet.SourceId"> <summary> <para> <para> A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. </para><para>Example: my-cluster-1, my-cluster-2</para><para>Example: my-snapshot-20131010</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSEventSubscriptionCmdlet.SourceType"> <summary> <para> <para> The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. </para><para>Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para> The name of the modified Amazon Redshift event notification subscription. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSEventSubscriptionCmdlet.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.RS.EditRSSnapshotCopyRetentionPeriodCmdlet"> <summary> Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSSnapshotCopyRetentionPeriodCmdlet.ClusterIdentifier"> <summary> <para> <para> The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region. </para><para> Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSSnapshotCopyRetentionPeriodCmdlet.RetentionPeriod"> <summary> <para> <para> The number of days to retain automated snapshots in the destination region after they are copied from the source region. </para><para> If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period. </para><para> Constraints: Must be at least 1 and no more than 35. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EditRSSnapshotCopyRetentionPeriodCmdlet.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.RS.EnableRSLoggingCmdlet"> <summary> Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSLoggingCmdlet.BucketName"> <summary> <para> <para> The name of an existing S3 bucket where the log files are to be stored. </para><para>Constraints:</para><ul><li>Must be in the same region as the cluster</li><li>The cluster must have read bucket and put object permissions</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSLoggingCmdlet.ClusterIdentifier"> <summary> <para> <para> The identifier of the cluster on which logging is to be started. </para><para>Example: <code>examplecluster</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSLoggingCmdlet.S3KeyPrefix"> <summary> <para> <para> The prefix applied to the log file names. </para><para>Constraints:</para><ul><li>Cannot exceed 512 characters</li><li>Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are: <ul><li>x00 to x20</li><li>x22</li><li>x27</li><li>x5c</li><li>x7f or larger</li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSLoggingCmdlet.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.RS.EnableRSSnapshotCopyCmdlet"> <summary> Enables the automatic copy of snapshots from one region to another region for a specified cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSSnapshotCopyCmdlet.ClusterIdentifier"> <summary> <para> <para> The unique identifier of the source cluster to copy snapshots from. </para><para> Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSSnapshotCopyCmdlet.DestinationRegion"> <summary> <para> <para> The destination region that you want to copy snapshots to. </para><para> Constraints: Must be the name of a valid region. For more information, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region">Regions and Endpoints</a> in the Amazon Web Services General Reference. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSSnapshotCopyCmdlet.RetentionPeriod"> <summary> <para> <para> The number of days to retain automated snapshots in the destination region after they are copied from the source region. </para><para> Default: 7. </para><para> Constraints: Must be at least 1 and no more than 35. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSSnapshotCopyCmdlet.SnapshotCopyGrantName"> <summary> <para> <para>The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.EnableRSSnapshotCopyCmdlet.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.RS.GetRSClusterParameterGroupsCmdlet"> <summary> Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para><para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all parameter groups that have any combination of those values are returned. </para><para> If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParameterGroupsCmdlet.ParameterGroupName"> <summary> <para> <para> The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParameterGroupsCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParameterGroupsCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParameterGroupsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterParameterGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParameterGroupsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParametersCmdlet"> <summary> Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on. <para> You can specify <i>source</i> filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from <a>ModifyClusterParameterGroup</a>, you can specify <i>source</i> equal to <i>user</i>. </para><para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParametersCmdlet.ParameterGroupName"> <summary> <para> <para> The name of a cluster parameter group for which to return details. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParametersCmdlet.Source"> <summary> <para> <para> The parameter types to return. Specify <code>user</code> to show parameters that are different form the default. Similarly, specify <code>engine-default</code> to show parameters that are the same as the default parameter group. </para><para>Default: All parameter types returned.</para><para>Valid Values: <code>user</code> | <code>engine-default</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParametersCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterParameters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterParametersCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSClustersCmdlet"> <summary> Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned. </para><para> If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClustersCmdlet.ClusterIdentifier"> <summary> <para> <para> The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. </para><para>The default is that all clusters defined for an account are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClustersCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClustersCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClustersCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para><para> Constraints: You can specify either the <b>ClusterIdentifier</b> parameter or the <b>Marker</b> parameter, but not both. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClustersCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSecurityGroupsCmdlet"> <summary> Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group. <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para><para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all security groups that have any combination of those values are returned. </para><para> If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSecurityGroupsCmdlet.ClusterSecurityGroupName"> <summary> <para> <para> The name of a cluster security group for which you are requesting details. You can specify either the <b>Marker</b> parameter or a <b>ClusterSecurityGroupName</b> parameter, but not both. </para><para> Example: <code>securitygroup1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSecurityGroupsCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSecurityGroupsCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSecurityGroupsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSecurityGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para><para> Constraints: You can specify either the <b>ClusterSecurityGroupName</b> parameter or the <b>Marker</b> parameter, but not both. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSecurityGroupsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet"> <summary> Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters. </para><para> If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.ClusterIdentifier"> <summary> <para> <para> The identifier of the cluster for which information about snapshots is requested. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.EndTime"> <summary> <para> <para> A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></para><para>Example: <code>2012-07-16T18:00:00Z</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.OwnerAccount"> <summary> <para> <para> The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.SnapshotIdentifier"> <summary> <para> <para> The snapshot identifier of the snapshot about which to return information. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.SnapshotType"> <summary> <para> <para> The type of snapshots for which you are requesting information. By default, snapshots of all types are returned. </para><para> Valid Values: <code>automated</code> | <code>manual</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.StartTime"> <summary> <para> <para> A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></para><para>Example: <code>2012-07-16T18:00:00Z</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSnapshots</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSnapshotsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSubnetGroupsCmdlet"> <summary> Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all subnet groups that have any combination of those values are returned. </para><para> If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSubnetGroupsCmdlet.ClusterSubnetGroupName"> <summary> <para> <para>The name of the cluster subnet group for which information is requested. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSubnetGroupsCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSubnetGroupsCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSubnetGroupsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterSubnetGroups</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterSubnetGroupsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSClusterVersionsCmdlet"> <summary> Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterVersionsCmdlet.ClusterParameterGroupFamily"> <summary> <para> <para> The name of a specific cluster parameter group family to return details for. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterVersionsCmdlet.ClusterVersion"> <summary> <para> <para> The specific cluster version to return. </para><para>Example: <code>1.0</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterVersionsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterVersions</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSClusterVersionsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSDefaultClusterParametersCmdlet"> <summary> Returns a list of parameter settings for the specified parameter group family. <para> For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSDefaultClusterParametersCmdlet.ParameterGroupFamily"> <summary> <para> <para> The name of the cluster parameter group family. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSDefaultClusterParametersCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeDefaultClusterParameters</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSDefaultClusterParametersCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSEventCategoriesCmdlet"> <summary> Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html">Amazon Redshift Event Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventCategoriesCmdlet.SourceType"> <summary> <para> <para> The source type, such as cluster or parameter group, to which the described event categories apply. </para><para> Valid values: cluster, snapshot, parameter group, and security group. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSEventsCmdlet"> <summary> Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventsCmdlet.Duration"> <summary> <para> <para> The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. </para><para>Default: <code>60</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventsCmdlet.EndTime"> <summary> <para> <para> The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></para><para>Example: <code>2009-07-08T18:00Z</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventsCmdlet.SourceIdentifier"> <summary> <para> <para> The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response. </para><para>Constraints:</para><para>If <i>SourceIdentifier</i> is supplied, <i>SourceType</i> must also be provided.</para><ul><li>Specify a cluster identifier when <i>SourceType</i> is <code>cluster</code>.</li><li>Specify a cluster security group name when <i>SourceType</i> is <code>cluster-security-group</code>.</li><li>Specify a cluster parameter group name when <i>SourceType</i> is <code>cluster-parameter-group</code>.</li><li>Specify a cluster snapshot identifier when <i>SourceType</i> is <code>cluster-snapshot</code>.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventsCmdlet.SourceType"> <summary> <para> <para> The event source to retrieve events for. If no value is specified, all events are returned. </para><para>Constraints:</para><para>If <i>SourceType</i> is supplied, <i>SourceIdentifier</i> must also be provided.</para><ul><li>Specify <code>cluster</code> when <i>SourceIdentifier</i> is a cluster identifier.</li><li>Specify <code>cluster-security-group</code> when <i>SourceIdentifier</i> is a cluster security group name.</li><li>Specify <code>cluster-parameter-group</code> when <i>SourceIdentifier</i> is a cluster parameter group name.</li><li>Specify <code>cluster-snapshot</code> when <i>SourceIdentifier</i> is a cluster snapshot identifier.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventsCmdlet.StartTime"> <summary> <para> <para> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></para><para>Example: <code>2009-07-08T18:00Z</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeEvents</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSEventSubscriptionsCmdlet"> <summary> Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventSubscriptionsCmdlet.SubscriptionName"> <summary> <para> <para>The name of the Amazon Redshift event notification subscription to be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventSubscriptionsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeEventSubscriptions</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSEventSubscriptionsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSHsmClientCertificatesCmdlet"> <summary> Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM client certificates that have any combination of those values are returned. </para><para> If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmClientCertificatesCmdlet.HsmClientCertificateIdentifier"> <summary> <para> <para>The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmClientCertificatesCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmClientCertificatesCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmClientCertificatesCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeHsmClientCertificates</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmClientCertificatesCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSHsmConfigurationsCmdlet"> <summary> Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account. <para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all HSM connections that have any combination of those values are returned. </para><para> If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmConfigurationsCmdlet.HsmConfigurationIdentifier"> <summary> <para> <para>The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmConfigurationsCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmConfigurationsCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmConfigurationsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeHsmConfigurations</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSHsmConfigurationsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSLoggingStatusCmdlet"> <summary> Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSLoggingStatusCmdlet.ClusterIdentifier"> <summary> <para> <para> The identifier of the cluster to get the logging status from. </para><para>Example: <code>examplecluster</code></para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSOrderableClusterOptionsCmdlet"> <summary> Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSOrderableClusterOptionsCmdlet.ClusterVersion"> <summary> <para> <para> The version filter value. Specify this parameter to show only the available offerings matching the specified version. </para><para>Default: All versions.</para><para>Constraints: Must be one of the version returned from <a>DescribeClusterVersions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSOrderableClusterOptionsCmdlet.NodeType"> <summary> <para> <para> The node type filter value. Specify this parameter to show only the available offerings matching the specified node type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSOrderableClusterOptionsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeOrderableClusterOptions</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSOrderableClusterOptionsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSReservedNodeOfferingsCmdlet"> <summary> Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to <a>PurchaseReservedNodeOffering</a> to reserve one or more nodes for your Amazon Redshift cluster. <para> For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSReservedNodeOfferingsCmdlet.ReservedNodeOfferingId"> <summary> <para> <para>The unique identifier for the offering.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSReservedNodeOfferingsCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeReservedNodeOfferings</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSReservedNodeOfferingsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSReservedNodesCmdlet"> <summary> Returns the descriptions of the reserved nodes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSReservedNodesCmdlet.ReservedNodeId"> <summary> <para> <para>Identifier for the node reservation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSReservedNodesCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeReservedNodes</a> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSReservedNodesCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSResizeCmdlet"> <summary> Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a <code>HTTP 404</code> error is returned. If a resize operation was initiated and completed, the status of the resize remains as <code>SUCCEEDED</code> until the next resize. <para> A resize operation can be requested using <a>ModifyCluster</a> and specifying a different number or type of nodes for the cluster. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSResizeCmdlet.ClusterIdentifier"> <summary> <para> <para> The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. </para><para>By default, resize operations for all clusters defined for an AWS account are returned. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSSnapshotCopyGrantCmdlet"> <summary> Returns a list of snapshot copy grants owned by the AWS account in the destination region. <para> For more information about managing snapshot copy grants, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSSnapshotCopyGrantCmdlet.SnapshotCopyGrantName"> <summary> <para> <para>The name of the snapshot copy grant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSSnapshotCopyGrantCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSSnapshotCopyGrantCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSSnapshotCopyGrantCmdlet.Marker"> <summary> <para> <para> An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeSnapshotCopyGrant</code> request exceed the value specified in <code>MaxRecords</code>, AWS returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </para><para> Constraints: You can specify either the <b>SnapshotCopyGrantName</b> parameter or the <b>Marker</b> parameter, but not both. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSSnapshotCopyGrantCmdlet.MaxRecord"> <summary> <para> <para> The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </para><para>Default: <code>100</code></para><para>Constraints: minimum 20, maximum 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.GetRSTagsCmdlet"> <summary> Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on. <para> The following are limitations for <code>DescribeTags</code>: <ul><li>You cannot specify an ARN and a resource-type value together in the same request.</li><li>You cannot use the <code>MaxRecords</code> and <code>Marker</code> parameters together with the ARN parameter.</li><li>The <code>MaxRecords</code> parameter can be a range from 10 to 50 results to return in a request.</li></ul></para><para> If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all resources that have any combination of those values are returned. </para><para> If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSTagsCmdlet.ResourceName"> <summary> <para> <para> The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSTagsCmdlet.ResourceType"> <summary> <para> <para> The type of resource with which you want to view tags. Valid resource types are: <ul><li>Cluster</li><li>CIDR/IP</li><li>EC2 security group</li><li>Snapshot</li><li>Cluster security group</li><li>Subnet group</li><li>HSM connection</li><li>HSM certificate</li><li>Parameter group</li><li>Snapshot copy grant</li></ul></para><para> For more information about Amazon Redshift resource types and constructing ARNs, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/constructing-redshift-arn.html">Constructing an Amazon Redshift Amazon Resource Name (ARN)</a> in the Amazon Redshift Cluster Management Guide. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSTagsCmdlet.TagKey"> <summary> <para> <para>A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called <code>owner</code> and <code>environment</code>. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSTagsCmdlet.TagValue"> <summary> <para> <para>A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called <code>admin</code> and <code>test</code>. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSTagsCmdlet.Marker"> <summary> <para> <para> A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the <code>marker</code> parameter and retrying the command. If the <code>marker</code> field is empty, all response records have been retrieved for the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.GetRSTagsCmdlet.MaxRecord"> <summary> <para> <para> The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned <code>marker</code> value. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet"> <summary> Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.AllowVersionUpgrade"> <summary> <para> <para>If <code>true</code>, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.</para><para> When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. </para><para>Default: <code>true</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.AutomatedSnapshotRetentionPeriod"> <summary> <para> <para> The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </para><para> Default: <code>1</code></para><para>Constraints: Must be a value from 0 to 35.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.AvailabilityZone"> <summary> <para> <para> The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. </para><para> Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. </para><para> Example: <code>us-east-1d</code></para><para> Constraint: The specified Availability Zone must be in the same region as the current endpoint. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.ClusterIdentifier"> <summary> <para> <para> A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. </para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>Alphabetic characters must be lowercase.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li><li>Must be unique for all clusters within an AWS account.</li></ul><para>Example: <code>myexamplecluster</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.ClusterParameterGroupName"> <summary> <para> <para> The name of the parameter group to be associated with this cluster. </para><para>Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon Redshift Parameter Groups</a></para><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.ClusterSecurityGroup"> <summary> <para> <para> A list of security groups to be associated with this cluster. </para><para> Default: The default cluster security group for Amazon Redshift. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.ClusterSubnetGroupName"> <summary> <para> <para> The name of a cluster subnet group to be associated with this cluster. </para><para> If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.ClusterType"> <summary> <para> <para> The type of the cluster. When cluster type is specified as <ul><li><code>single-node</code>, the <b>NumberOfNodes</b> parameter is not required.</li><li><code>multi-node</code>, the <b>NumberOfNodes</b> parameter is required.</li></ul></para><para> Valid Values: <code>multi-node</code> | <code>single-node</code></para><para>Default: <code>multi-node</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.ClusterVersion"> <summary> <para> <para> The version of the Amazon Redshift engine software that you want to deploy on the cluster. </para><para> The version selected runs on all the nodes in the cluster. </para><para>Constraints: Only version 1.0 is currently available.</para><para>Example: <code>1.0</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.DBName"> <summary> <para> <para>The name of the first database to be created when the cluster is created. </para><para>To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html">Create a Database</a> in the Amazon Redshift Database Developer Guide. </para><para>Default: <code>dev</code></para><para>Constraints:</para><ul><li>Must contain 1 to 64 alphanumeric characters.</li><li>Must contain only lowercase letters.</li><li>Cannot be a word that is reserved by the service. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.ElasticIp"> <summary> <para> <para>The Elastic IP (EIP) address for the cluster.</para><para>Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported Platforms to Launch Your Cluster</a> in the Amazon Redshift Cluster Management Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.Encrypted"> <summary> <para> <para>If <code>true</code>, the data in the cluster is encrypted at rest. </para><para>Default: false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.HsmClientCertificateIdentifier"> <summary> <para> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.HsmConfigurationIdentifier"> <summary> <para> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.KmsKeyId"> <summary> <para> <para>The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.MasterUsername"> <summary> <para> <para> The user name associated with the master user account for the cluster that is being created. </para><para>Constraints:</para><ul><li>Must be 1 - 128 alphanumeric characters.</li><li>First character must be a letter.</li><li>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide. </li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.MasterUserPassword"> <summary> <para> <para> The password associated with the master user account for the cluster that is being created. </para><para> Constraints: </para><ul><li>Must be between 8 and 64 characters in length.</li><li>Must contain at least one uppercase letter.</li><li>Must contain at least one lowercase letter.</li><li>Must contain one number.</li><li>Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.NodeType"> <summary> <para> <para> The node type to be provisioned for the cluster. For information about node types, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para><para> Valid Values: <code>ds1.xlarge</code> | <code>ds1.8xlarge</code> | <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.NumberOfNodes"> <summary> <para> <para> The number of compute nodes in the cluster. This parameter is required when the <b>ClusterType</b> parameter is specified as <code>multi-node</code>. </para><para>For information about determining how many nodes you need, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para><para>If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.</para><para>Default: <code>1</code></para><para>Constraints: Value must be at least 1 and no more than 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.Port"> <summary> <para> <para> The port number on which the cluster accepts incoming connections. </para><para>The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.</para><para> Default: <code>5439</code></para><para> Valid Values: <code>1150-65535</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para> The weekly time range (in UTC) during which automated cluster maintenance can occur. </para><para> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></para><para> Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows">Maintenance Windows</a> in Amazon Redshift Cluster Management Guide.</para><para>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</para><para>Constraints: Minimum 30-minute window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.PubliclyAccessible"> <summary> <para> <para>If <code>true</code>, the cluster can be accessed from a public network. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.VpcSecurityGroupId"> <summary> <para> <para>A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.</para><para>Default: The default VPC security group is associated with the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterCmdlet.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.RS.NewRSClusterParameterGroupCmdlet"> <summary> Creates an Amazon Redshift parameter group. <para> Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using <a>ModifyCluster</a>. </para><para> Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterParameterGroupCmdlet.Description"> <summary> <para> <para> A description of the parameter group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterParameterGroupCmdlet.ParameterGroupFamily"> <summary> <para> <para> The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. </para><para>To get a list of valid parameter group family names, you can call <a>DescribeClusterParameterGroups</a>. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0". </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterParameterGroupCmdlet.ParameterGroupName"> <summary> <para> <para> The name of the cluster parameter group. </para><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li><li>Must be unique withing your AWS account.</li></ul><note>This value is stored as a lower-case string.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterParameterGroupCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterParameterGroupCmdlet.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.RS.NewRSClusterSecurityGroupCmdlet"> <summary> Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. <para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSecurityGroupCmdlet.ClusterSecurityGroupName"> <summary> <para> <para> The name for the security group. Amazon Redshift stores the value as a lowercase string. </para><para>Constraints: </para><ul><li>Must contain no more than 255 alphanumeric characters or hyphens.</li><li>Must not be "Default".</li><li>Must be unique for all security groups that are created by your AWS account.</li></ul><para>Example: <code>examplesecuritygroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSecurityGroupCmdlet.Description"> <summary> <para> <para> A description for the security group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSecurityGroupCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSecurityGroupCmdlet.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.RS.NewRSClusterSnapshotCmdlet"> <summary> Creates a manual snapshot of the specified cluster. The cluster must be in the <code>available</code> state. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSnapshotCmdlet.ClusterIdentifier"> <summary> <para> <para> The cluster identifier for which you want a snapshot. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSnapshotCmdlet.SnapshotIdentifier"> <summary> <para> <para> A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. </para><para>Constraints:</para><ul><li>Cannot be null, empty, or blank</li><li>Must contain from 1 to 255 alphanumeric characters or hyphens</li><li>First character must be a letter</li><li>Cannot end with a hyphen or contain two consecutive hyphens</li></ul><para>Example: <code>my-snapshot-id</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSnapshotCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSnapshotCmdlet.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.RS.NewRSClusterSubnetGroupCmdlet"> <summary> Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group. <para> For information about subnet groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html">Amazon Redshift Cluster Subnet Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSubnetGroupCmdlet.ClusterSubnetGroupName"> <summary> <para> <para> The name for the subnet group. Amazon Redshift stores the value as a lowercase string. </para><para>Constraints: </para><ul><li>Must contain no more than 255 alphanumeric characters or hyphens.</li><li>Must not be "Default".</li><li>Must be unique for all subnet groups that are created by your AWS account.</li></ul><para>Example: <code>examplesubnetgroup</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSubnetGroupCmdlet.Description"> <summary> <para> <para>A description for the subnet group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSubnetGroupCmdlet.SubnetId"> <summary> <para> <para> An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSubnetGroupCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSClusterSubnetGroupCmdlet.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.RS.NewRSEventSubscriptionCmdlet"> <summary> Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. <para> You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters. </para><para> If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.Enabled"> <summary> <para> <para> A Boolean value; set to <code>true</code> to activate the subscription, set to <code>false</code> to create the subscription but not active it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.EventCategory"> <summary> <para> <para>Specifies the Amazon Redshift event categories to be published by the event notification subscription.</para><para>Values: Configuration, Management, Monitoring, Security</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.Severity"> <summary> <para> <para>Specifies the Amazon Redshift event severity to be published by the event notification subscription.</para><para>Values: ERROR, INFO</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.SnsTopicArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.SourceId"> <summary> <para> <para> A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified. </para><para>Example: my-cluster-1, my-cluster-2</para><para>Example: my-snapshot-20131010</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.SourceType"> <summary> <para> <para> The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs. </para><para>Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para> The name of the event subscription to be created. </para><para>Constraints:</para><ul><li>Cannot be null, empty, or blank.</li><li>Must contain from 1 to 255 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSEventSubscriptionCmdlet.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.RS.NewRSHsmClientCertificateCmdlet"> <summary> Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases. <para> The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a> in the Amazon Redshift Cluster Management Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmClientCertificateCmdlet.HsmClientCertificateIdentifier"> <summary> <para> <para>The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmClientCertificateCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmClientCertificateCmdlet.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.RS.NewRSHsmConfigurationCmdlet"> <summary> Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM. <para> In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html">Hardware Security Modules</a> in the Amazon Redshift Cluster Management Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmConfigurationCmdlet.Description"> <summary> <para> <para>A text description of the HSM configuration to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmConfigurationCmdlet.HsmConfigurationIdentifier"> <summary> <para> <para>The identifier to be assigned to the new Amazon Redshift HSM configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmConfigurationCmdlet.HsmIpAddress"> <summary> <para> <para>The IP address that the Amazon Redshift cluster must use to access the HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmConfigurationCmdlet.HsmPartitionName"> <summary> <para> <para>The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmConfigurationCmdlet.HsmPartitionPassword"> <summary> <para> <para>The password required to access the HSM partition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmConfigurationCmdlet.HsmServerPublicCertificate"> <summary> <para> <para>The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmConfigurationCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSHsmConfigurationCmdlet.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.RS.NewRSSnapshotCopyGrantCmdlet"> <summary> Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region. <para> For more information about managing snapshot copy grants, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSSnapshotCopyGrantCmdlet.KmsKeyId"> <summary> <para> <para>The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSSnapshotCopyGrantCmdlet.SnapshotCopyGrantName"> <summary> <para> <para>The name of the snapshot copy grant. This name must be unique in the region for the AWS account.</para><para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>Alphabetic characters must be lowercase.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li><li>Must be unique for all clusters within an AWS account.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSSnapshotCopyGrantCmdlet.Tag"> <summary> <para> <para>A list of tag instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSSnapshotCopyGrantCmdlet.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.RS.NewRSTagsCmdlet"> <summary> Adds one or more tags to a specified resource. <para> A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail. </para><para> If you specify a key that already exists for the resource, the value for that key will be updated with the new value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSTagsCmdlet.ResourceName"> <summary> <para> <para> The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSTagsCmdlet.Tag"> <summary> <para> <para> One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter <code>Key</code> and the corresponding value is passed in with the parameter <code>Value</code>. The <code>Key</code> and <code>Value</code> parameters are separated by a comma (,). Separate multiple tags with a space. For example, <code>--tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0"</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.NewRSTagsCmdlet.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.RS.RemoveRSClusterCmdlet"> <summary> Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use <a>DescribeClusters</a> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . <para> If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. </para><para> For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> . </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterCmdlet.ClusterIdentifier"> <summary> <para> <para> The identifier of the cluster to be deleted. </para><para>Constraints:</para><ul><li>Must contain lowercase characters.</li><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterCmdlet.FinalClusterSnapshotIdentifier"> <summary> <para> <para> The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, <i>SkipFinalClusterSnapshot</i> must be <code>false</code>. </para><para>Constraints:</para><ul><li>Must be 1 to 255 alphanumeric characters.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterCmdlet.SkipFinalClusterSnapshot"> <summary> <para> <para> Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If <code>false</code>, a final cluster snapshot is created before the cluster is deleted. </para><note>The <i>FinalClusterSnapshotIdentifier</i> parameter must be specified if <i>SkipFinalClusterSnapshot</i> is <code>false</code>.</note><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterCmdlet.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.RS.RemoveRSClusterParameterGroupCmdlet"> <summary> Deletes a specified Amazon Redshift parameter group. <note>You cannot delete a parameter group if it is associated with a cluster.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterParameterGroupCmdlet.ParameterGroupName"> <summary> <para> <para> The name of the parameter group to be deleted. </para><para>Constraints:</para><ul><li>Must be the name of an existing cluster parameter group.</li><li>Cannot delete a default cluster parameter group.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterParameterGroupCmdlet.PassThru"> <summary> Returns the value passed to the ParameterGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterParameterGroupCmdlet.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.RS.RemoveRSClusterSecurityGroupCmdlet"> <summary> Deletes an Amazon Redshift security group. <note>You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.</note><para> For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSecurityGroupCmdlet.ClusterSecurityGroupName"> <summary> <para> <para> The name of the cluster security group to be deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSecurityGroupCmdlet.PassThru"> <summary> Returns the value passed to the ClusterSecurityGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSecurityGroupCmdlet.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.RS.RemoveRSClusterSnapshotCmdlet"> <summary> Deletes the specified manual snapshot. The snapshot must be in the <code>available</code> state, with no other users authorized to access the snapshot. <para> Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSnapshotCmdlet.SnapshotClusterIdentifier"> <summary> <para> <para> The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </para><para>Constraints: Must be the name of valid cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSnapshotCmdlet.SnapshotIdentifier"> <summary> <para> <para> The unique identifier of the manual snapshot to be deleted. </para><para>Constraints: Must be the name of an existing snapshot that is in the <code>available</code> state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSnapshotCmdlet.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.RS.RemoveRSClusterSubnetGroupCmdlet"> <summary> Deletes the specified cluster subnet group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSubnetGroupCmdlet.ClusterSubnetGroupName"> <summary> <para> <para>The name of the cluster subnet group name to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSubnetGroupCmdlet.PassThru"> <summary> Returns the value passed to the ClusterSubnetGroupName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSClusterSubnetGroupCmdlet.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.RS.RemoveRSEventSubscriptionCmdlet"> <summary> Deletes an Amazon Redshift event notification subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSEventSubscriptionCmdlet.SubscriptionName"> <summary> <para> <para>The name of the Amazon Redshift event notification subscription to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSEventSubscriptionCmdlet.PassThru"> <summary> Returns the value passed to the SubscriptionName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSEventSubscriptionCmdlet.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.RS.RemoveRSHsmClientCertificateCmdlet"> <summary> Deletes the specified HSM client certificate. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSHsmClientCertificateCmdlet.HsmClientCertificateIdentifier"> <summary> <para> <para>The identifier of the HSM client certificate to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSHsmClientCertificateCmdlet.PassThru"> <summary> Returns the value passed to the HsmClientCertificateIdentifier parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSHsmClientCertificateCmdlet.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.RS.RemoveRSHsmConfigurationCmdlet"> <summary> Deletes the specified Amazon Redshift HSM configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSHsmConfigurationCmdlet.HsmConfigurationIdentifier"> <summary> <para> <para>The identifier of the Amazon Redshift HSM configuration to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSHsmConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the HsmConfigurationIdentifier parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSHsmConfigurationCmdlet.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.RS.RemoveRSSnapshotCopyGrantCmdlet"> <summary> Deletes the specified snapshot copy grant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSSnapshotCopyGrantCmdlet.SnapshotCopyGrantName"> <summary> <para> <para>The name of the snapshot copy grant to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSSnapshotCopyGrantCmdlet.PassThru"> <summary> Returns the value passed to the SnapshotCopyGrantName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSSnapshotCopyGrantCmdlet.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.RS.RemoveRSTagsCmdlet"> <summary> Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSTagsCmdlet.ResourceName"> <summary> <para> <para> The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSTagsCmdlet.TagKey"> <summary> <para> <para>The tag key that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RemoveRSTagsCmdlet.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.RS.RequestRSReservedNodeOfferingCmdlet"> <summary> Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the <a>DescribeReservedNodeOfferings</a> API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. <para> For more information about reserved node offerings, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RequestRSReservedNodeOfferingCmdlet.NodeCount"> <summary> <para> <para>The number of reserved nodes you want to purchase.</para><para>Default: <code>1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RequestRSReservedNodeOfferingCmdlet.ReservedNodeOfferingId"> <summary> <para> <para>The unique identifier of the reserved node offering you want to purchase.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RequestRSReservedNodeOfferingCmdlet.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.RS.ResetRSClusterParameterGroupCmdlet"> <summary> Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the <i>ResetAllParameters</i> parameter. For parameter changes to take effect you must reboot any associated clusters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ResetRSClusterParameterGroupCmdlet.ParameterGroupName"> <summary> <para> <para> The name of the cluster parameter group to be reset. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ResetRSClusterParameterGroupCmdlet.Parameter"> <summary> <para> <para> An array of names of parameters to be reset. If <i>ResetAllParameters</i> option is not used, then at least one parameter name must be supplied. </para><para>Constraints: A maximum of 20 parameters can be reset in a single request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ResetRSClusterParameterGroupCmdlet.ResetAllParameter"> <summary> <para> <para> If <code>true</code>, all parameters in the specified parameter group will be reset to their default values. </para><para>Default: <code>true</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.ResetRSClusterParameterGroupCmdlet.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.RS.RestartRSClusterCmdlet"> <summary> Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to <code>rebooting</code>. A cluster event is created when the reboot is completed. Any pending cluster modifications (see <a>ModifyCluster</a>) are applied at this reboot. For more information about managing clusters, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestartRSClusterCmdlet.ClusterIdentifier"> <summary> <para> <para> The cluster identifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestartRSClusterCmdlet.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.RS.RestoreRSFromClusterSnapshotCmdlet"> <summary> Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the <a>ModifyCluster</a> API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. <para> If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. </para><para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.AllowVersionUpgrade"> <summary> <para> <para> If <code>true</code>, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. </para><para>Default: <code>true</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.AutomatedSnapshotRetentionPeriod"> <summary> <para> <para> The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </para><para> Default: The value selected for the cluster from which the snapshot was taken. </para><para>Constraints: Must be a value from 0 to 35.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.AvailabilityZone"> <summary> <para> <para> The Amazon EC2 Availability Zone in which to restore the cluster. </para><para>Default: A random, system-chosen Availability Zone.</para><para>Example: <code>us-east-1a</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.ClusterIdentifier"> <summary> <para> <para> The identifier of the cluster that will be created from restoring the snapshot. </para><para><para>Constraints:</para><ul><li>Must contain from 1 to 63 alphanumeric characters or hyphens.</li><li>Alphabetic characters must be lowercase.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li><li>Must be unique for all clusters within an AWS account.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.ClusterParameterGroupName"> <summary> <para> <para> The name of the parameter group to be associated with this cluster. </para><para>Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon Redshift Parameter Groups</a>.</para><para> Constraints: </para><ul><li>Must be 1 to 255 alphanumeric characters or hyphens.</li><li>First character must be a letter.</li><li>Cannot end with a hyphen or contain two consecutive hyphens.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.ClusterSecurityGroup"> <summary> <para> <para> A list of security groups to be associated with this cluster. </para><para> Default: The default cluster security group for Amazon Redshift. </para><para>Cluster security groups only apply to clusters outside of VPCs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.ClusterSubnetGroupName"> <summary> <para> <para> The name of the subnet group where you want to cluster restored. </para><para> A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.ElasticIp"> <summary> <para> <para>The elastic IP (EIP) address for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.HsmClientCertificateIdentifier"> <summary> <para> <para>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.HsmConfigurationIdentifier"> <summary> <para> <para>Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.KmsKeyId"> <summary> <para> <para>The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.NodeType"> <summary> <para> <para> The node type that the restored cluster will be provisioned with.</para><para> Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes"> About Clusters and Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.OwnerAccount"> <summary> <para> <para> The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.Port"> <summary> <para> <para> The port number on which the cluster accepts connections. </para><para>Default: The same port as the original cluster.</para><para>Constraints: Must be between <code>1115</code> and <code>65535</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para> The weekly time range (in UTC) during which automated cluster maintenance can occur. </para><para> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></para><para> Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows">Maintenance Windows</a> in Amazon Redshift Cluster Management Guide. </para><para>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</para><para>Constraints: Minimum 30-minute window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.PubliclyAccessible"> <summary> <para> <para> If <code>true</code>, the cluster can be accessed from a public network. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.SnapshotClusterIdentifier"> <summary> <para> <para> The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.SnapshotIdentifier"> <summary> <para> <para> The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. </para><para>Example: <code>my-snapshot-id</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.VpcSecurityGroupId"> <summary> <para> <para> A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. </para><para> Default: The default VPC security group is associated with the cluster. </para><para> VPC security groups only apply to clusters in VPCs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RestoreRSFromClusterSnapshotCmdlet.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.RS.RevokeRSClusterSecurityGroupIngressCmdlet"> <summary> Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see <a>AuthorizeClusterSecurityGroupIngress</a>. For information about managing security groups, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html">Amazon Redshift Cluster Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSClusterSecurityGroupIngressCmdlet.CIDRIP"> <summary> <para> <para> The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If <code>CIDRIP</code> is specified, <code>EC2SecurityGroupName</code> and <code>EC2SecurityGroupOwnerId</code> cannot be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSClusterSecurityGroupIngressCmdlet.ClusterSecurityGroupName"> <summary> <para> <para> The name of the security Group from which to revoke the ingress rule. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSClusterSecurityGroupIngressCmdlet.EC2SecurityGroupName"> <summary> <para> <para> The name of the EC2 Security Group whose access is to be revoked. If <code>EC2SecurityGroupName</code> is specified, <code>EC2SecurityGroupOwnerId</code> must also be provided and <code>CIDRIP</code> cannot be provided. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSClusterSecurityGroupIngressCmdlet.EC2SecurityGroupOwnerId"> <summary> <para> <para> The AWS account number of the owner of the security group specified in the <code>EC2SecurityGroupName</code> parameter. The AWS access key ID is not an acceptable value. If <code>EC2SecurityGroupOwnerId</code> is specified, <code>EC2SecurityGroupName</code> must also be provided. and <code>CIDRIP</code> cannot be provided. </para><para>Example: <code>111122223333</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSClusterSecurityGroupIngressCmdlet.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.RS.RevokeRSSnapshotAccessCmdlet"> <summary> Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion. <para> For more information about working with snapshots, go to <a href="http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSSnapshotAccessCmdlet.AccountWithRestoreAccess"> <summary> <para> <para> The identifier of the AWS customer account that can no longer restore the specified snapshot. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSSnapshotAccessCmdlet.SnapshotClusterIdentifier"> <summary> <para> <para> The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSSnapshotAccessCmdlet.SnapshotIdentifier"> <summary> <para> <para> The identifier of the snapshot that the account can no longer access. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.RevokeRSSnapshotAccessCmdlet.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.RS.SwitchRSEncryptionKeyCmdlet"> <summary> Rotates the encryption keys for a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.SwitchRSEncryptionKeyCmdlet.ClusterIdentifier"> <summary> <para> <para> The unique identifier of the cluster that you want to rotate the encryption keys for. </para><para> Constraints: Must be the name of valid cluster that has encryption enabled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RS.SwitchRSEncryptionKeyCmdlet.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.R53D.DisableR53DDomainAutoRenewCmdlet"> <summary> This operation disables automatic renewal of domain registration for the specified domain. <note>Caution! Amazon Route 53 doesn't have a manual renewal process, so if you disable automatic renewal, registration for the domain will not be renewed when the expiration date passes, and you will lose control of the domain name.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.DisableR53DDomainAutoRenewCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.DisableR53DDomainAutoRenewCmdlet.PassThru"> <summary> Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.DisableR53DDomainAutoRenewCmdlet.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.R53D.DisableR53DDomainTransferLockCmdlet"> <summary> This operation removes the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.DisableR53DDomainTransferLockCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.DisableR53DDomainTransferLockCmdlet.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.R53D.EnableR53DDomainAutoRenewCmdlet"> <summary> This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account. <para> The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see <a href="http://wiki.gandi.net/en/domains/renew#renewal_restoration_and_deletion_times">"Renewal, restoration, and deletion times"</a> on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.EnableR53DDomainAutoRenewCmdlet.DomainName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.EnableR53DDomainAutoRenewCmdlet.PassThru"> <summary> Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.EnableR53DDomainAutoRenewCmdlet.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.R53D.EnableR53DDomainTransferLockCmdlet"> <summary> This operation sets the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.EnableR53DDomainTransferLockCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.EnableR53DDomainTransferLockCmdlet.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.R53D.GetR53DDomainAuthCodeCmdlet"> <summary> This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainAuthCodeCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainAvailabilityCmdlet"> <summary> This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainAvailabilityCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainAvailabilityCmdlet.IdnLangCode"> <summary> <para> <para>Reserved for future use.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainDetailCmdlet"> <summary> This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainDetailCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainsCmdlet"> <summary> This operation returns all the domain names registered with Amazon Route 53 for the current AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainsCmdlet.Marker"> <summary> <para> <para>For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional domains. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The marker must match the value specified in the previous request. </para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DDomainsCmdlet.MaxItem"> <summary> <para> <para>Number of domains to be returned.</para><para>Type: Integer</para><para>Default: 20</para><para>Constraints: A numeral between 1 and 100.</para><para>Required: No</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53D.GetR53DOperationDetailCmdlet"> <summary> This operation returns the current status of an operation that is not completed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DOperationDetailCmdlet.OperationId"> <summary> <para> <para>The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.</para><para>Type: String</para><para>Default: None</para><para>Required: Yes</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53D.GetR53DOperationsCmdlet"> <summary> This operation returns the operation IDs of operations that are not yet complete. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DOperationsCmdlet.Marker"> <summary> <para> <para>For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code> to return additional operations. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element.</para><para>Type: String</para><para>Default: None</para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DOperationsCmdlet.MaxItem"> <summary> <para> <para>Number of domains to be returned.</para><para>Type: Integer</para><para>Default: 20</para><para>Constraints: A value between 1 and 100.</para><para>Required: No</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53D.GetR53DTagsForDomainCmdlet"> <summary> This operation returns all of the tags that are associated with the specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.GetR53DTagsForDomainCmdlet.DomainName"> <summary> <para> <para>The domain for which you want to get a list of tags.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet"> <summary> This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi. <para> For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html">Transferring Registration for a Domain to Amazon Route 53</a> in the Amazon Route 53 Developer Guide. </para><para> If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. </para><note>Caution! If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.</note><para> If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AuthCode"> <summary> <para> <para>The authorization code for the domain. You get this value from the current registrar.</para><para>Type: String</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AutoRenew"> <summary> <para> <para>Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.</para><para>Type: Boolean</para><para>Valid values: <code>true</code> | <code>false</code></para><para>Default: true</para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.DurationInYears"> <summary> <para> <para>The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.</para><para>Type: Integer</para><para>Default: 1</para><para>Valid values: Integer from 1 to 10</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.IdnLangCode"> <summary> <para> <para>Reserved for future use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.Nameserver"> <summary> <para> <para>Contains details for the host and glue IP addresses.</para><para>Type: Complex</para><para>Children: <code>GlueIps</code>, <code>Name</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.PrivacyProtectAdminContact"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: <code>true</code></para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.PrivacyProtectRegistrantContact"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: <code>true</code></para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.PrivacyProtectTechContact"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: <code>true</code></para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.AdminContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.RegistrantContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.TechContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.InvokeR53DDomainTransferCmdlet.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.R53D.RegisterR53DDomainCmdlet"> <summary> This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters. <para> When you register a domain, Amazon Route 53 does the following: </para><ul><li>Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.</li><li>Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.</li><li>Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.</li><li>If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.</li><li>Charges your AWS account an amount based on the top-level domain. For more information, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AutoRenew"> <summary> <para> <para>Indicates whether the domain will be automatically renewed (<code>true</code>) or not (<code>false</code>). Autorenewal only takes effect after the account is charged.</para><para>Type: Boolean</para><para>Valid values: <code>true</code> | <code>false</code></para><para>Default: <code>true</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.DurationInYears"> <summary> <para> <para>The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.</para><para>Type: Integer</para><para>Default: 1</para><para>Valid values: Integer from 1 to 10</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.IdnLangCode"> <summary> <para> <para>Reserved for future use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.PrivacyProtectAdminContact"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: <code>true</code></para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.PrivacyProtectRegistrantContact"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: <code>true</code></para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.PrivacyProtectTechContact"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: <code>true</code></para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.AdminContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.RegistrantContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.TechContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RegisterR53DDomainCmdlet.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.R53D.RemoveR53DTagsForDomainCmdlet"> <summary> This operation deletes the specified tags for a domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RemoveR53DTagsForDomainCmdlet.DomainName"> <summary> <para> <para>The domain for which you want to delete one or more tags.</para><para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when theyaposre surrounded by letters, numbers, or other hyphens. You canapost specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RemoveR53DTagsForDomainCmdlet.TagsToDelete"> <summary> <para> <para>A list of tag keys to delete.</para><para>Type: A list that contains the keys of the tags that you want to delete.</para><para>Default: None</para><para>Required: No</para> '> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RemoveR53DTagsForDomainCmdlet.PassThru"> <summary> Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.RemoveR53DTagsForDomainCmdlet.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.R53D.UpdateR53DDomainContactCmdlet"> <summary> This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update. <para> If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_AddressLine1"> <summary> <para> <para>First line of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_AddressLine2"> <summary> <para> <para>Second line of contact's address, if any.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_City"> <summary> <para> <para>The city of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_ContactType"> <summary> <para> <para>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_CountryCode"> <summary> <para> <para>Code for the country of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_Email"> <summary> <para> <para>Email address of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 254 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_ExtraParam"> <summary> <para> <para>A list of name-value pairs for parameters required by certain top-level domains.</para><para>Type: Complex</para><para>Default: None</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Children: <code>Name</code>, <code>Value</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_Fax"> <summary> <para> <para>Fax number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_FirstName"> <summary> <para> <para>First name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_LastName"> <summary> <para> <para>Last name of contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_OrganizationName"> <summary> <para> <para>Name of the organization for contact types other than <code>PERSON</code>.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_PhoneNumber"> <summary> <para> <para>The phone number of the contact.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as <code>"+1.1234567890"</code>.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_State"> <summary> <para> <para>The state or province of the contact's city.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.AdminContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.RegistrantContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.TechContact_ZipCode"> <summary> <para> <para>The zip or postal code of the contact's address.</para><para>Type: String</para><para>Default: None</para><para>Constraints: Maximum 255 characters.</para><para>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactCmdlet.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.R53D.UpdateR53DDomainContactPrivacyCmdlet"> <summary> This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the <a href="http://www.gandi.net/domain/whois/?currency=USD&amp;lang=en">Gandi privacy features</a>. <para> This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactPrivacyCmdlet.AdminPrivacy"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: None</para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactPrivacyCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactPrivacyCmdlet.RegistrantPrivacy"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: None</para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactPrivacyCmdlet.TechPrivacy"> <summary> <para> <para>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</para><para>Type: Boolean</para><para>Default: None</para><para>Valid values: <code>true</code> | <code>false</code></para><para>Required: No</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainContactPrivacyCmdlet.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.R53D.UpdateR53DDomainNameserversCmdlet"> <summary> This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. <para> If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainNameserversCmdlet.DomainName"> <summary> <para> <para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainNameserversCmdlet.FIAuthKey"> <summary> <para> <para>The authorization key for .fi domains</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainNameserversCmdlet.Nameserver"> <summary> <para> <para>A list of new name servers for the domain.</para><para>Type: Complex</para><para>Children: <code>Name</code>, <code>GlueIps</code></para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DDomainNameserversCmdlet.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.R53D.UpdateR53DTagsForDomainCmdlet"> <summary> This operation adds or updates tags for a specified domain. <para> All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DTagsForDomainCmdlet.DomainName"> <summary> <para> <para>The domain for which you want to add or update tags.</para><para>The name of a domain.</para><para>Type: String</para><para>Default: None</para><para>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when theyaposre surrounded by letters, numbers, or other hyphens. You canapost specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.</para><para>Required: Yes</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DTagsForDomainCmdlet.TagsToUpdate"> <summary> <para> <para>A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.</para><para>Type: A complex type containing a list of tags</para><para>Default: None</para><para>Required: No</para> '> <para>Each tag includes the following elements:</para><ul><li><para>Key</para><para>The key (name) of a tag.</para><para>Type: String</para><para>Default: None</para><para>Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"</para><para>Constraints: Each key can be 1-128 characters long.</para><para>Required: Yes</para></li><li><para>Value</para><para>The value of a tag.</para><para>Type: String</para><para>Default: None</para><para>Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"</para><para>Constraints: Each value can be 0-256 characters long.</para><para>Required: Yes</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DTagsForDomainCmdlet.PassThru"> <summary> Returns the value passed to the DomainName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53D.UpdateR53DTagsForDomainCmdlet.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.R53.GetR53HostedZonesByNameCmdlet"> <summary> To retrieve a list of your hosted zones in lexicographic order, send a <code>GET</code> request to the <code>2013-04-01/hostedzonesbyname</code> resource. The response to this request includes a <code>HostedZones</code> element with zero or more <code>HostedZone</code> child elements lexicographically ordered by DNS name. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the <code>MaxItems</code> parameter. You can use the <code>DNSName</code> and <code>HostedZoneId</code> parameters to control the hosted zone that the list begins with. <note> Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZonesByNameCmdlet.DNSName"> <summary> <para> Gets and sets the property DNSName. <para> The first name in the lexicographic ordering of domain names that you want the <code>ListHostedZonesByNameRequest</code> request to list. </para><para> If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker$DNSName</code> and <code>NextMarker$HostedZoneId</code> from the last response in the <code>DNSName</code> and <code>HostedZoneId</code> parameters to get the next page of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZonesByNameCmdlet.HostedZoneId"> <summary> <para> Gets and sets the property HostedZoneId. <para> If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker$DNSName</code> and <code>NextMarker$HostedZoneId</code> from the last response in the <code>DNSName</code> and <code>HostedZoneId</code> parameters to get the next page of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZonesByNameCmdlet.MaxItem"> <summary> <para> Gets and sets the property MaxItems. <para> Specify the maximum number of hosted zones to return per page of results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.EditR53ResourceRecordSetCmdlet"> <summary> Use this action to create or change your authoritative DNS information. To use this action, send a <code>POST</code> request to the <code>2013-04-01/hostedzone/<i>hosted Zone ID</i>/rrset</code> resource. The request body must include an XML document with a <code>ChangeResourceRecordSetsRequest</code> element. <para> Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/RRSchanges.html#RRSchanges_API">Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API</a> in the <i>Amazon Route 53 Developer Guide</i>. </para><important>Due to the nature of transactional changes, you cannot delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an <code>InvalidChangeBatch</code> error.</important><para> In response to a <code>ChangeResourceRecordSets</code> request, your DNS data is changed on all Route 53 DNS servers. Initially, the status of a change is <code>PENDING</code>. This means the change has not yet propagated to all the authoritative Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of <code>INSYNC</code>. </para><para> Note the following limitations on a <code>ChangeResourceRecordSets</code> request: </para><para> - A request cannot contain more than 100 Change elements. </para><para> - A request cannot contain more than 1000 ResourceRecord elements. </para><para> The sum of the number of characters (including spaces) in all <code>Value</code> elements in a request cannot exceed 32,000 characters. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53ResourceRecordSetCmdlet.ChangeBatch_Change"> <summary> <para> <para>A complex type that contains one <code>Change</code> element for each resource record set that you want to create or delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53ResourceRecordSetCmdlet.ChangeBatch_Comment"> <summary> <para> <para><i>Optional:</i> Any comments you want to include about a change batch request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53ResourceRecordSetCmdlet.HostedZoneId"> <summary> <para> <para> The ID of the hosted zone that contains the resource record sets that you want to change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53ResourceRecordSetCmdlet.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> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.R53.EditR53TagsForResourceCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53TagsForResourceCmdlet.AddTag"> <summary> <para> <para>A complex type that contains a list of <code>Tag</code> elements. Each <code>Tag</code> element identifies a tag that you want to add or update for the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53TagsForResourceCmdlet.RemoveTagKey"> <summary> <para> <para>A list of <code>Tag</code> keys that you want to remove from the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53TagsForResourceCmdlet.ResourceId"> <summary> <para> <para>The ID of the resource for which you want to add, change, or delete tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53TagsForResourceCmdlet.ResourceType"> <summary> <para> <para>The type of the resource.</para><para>- The resource type for health checks is <code>healthcheck</code>.</para><para>- The resource type for hosted zones is <code>hostedzone</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53TagsForResourceCmdlet.PassThru"> <summary> Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.EditR53TagsForResourceCmdlet.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.R53.GetR53ChangeCmdlet"> <summary> This action returns the current status of a change batch request. The status is one of the following values: <para> - <code>PENDING</code> indicates that the changes in this request have not replicated to all Route 53 DNS servers. This is the initial status of all change batch requests. </para><para> - <code>INSYNC</code> indicates that the changes have replicated to all Amazon Route 53 DNS servers. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ChangeCmdlet.Id"> <summary> <para> <para> The ID of the change batch request. The value that you specify here is the value that <code>ChangeResourceRecordSets</code> returned in the Id element when you submitted the request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53CheckerIpRangesCmdlet"> <summary> To retrieve a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources, send a <code>GET</code> request to the <code>2013-04-01/checkeripranges</code> resource. You can use these IP addresses to configure router and firewall rules to allow health checkers to check the health of your resources. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationCmdlet"> <summary> To retrieve a single geo location, send a <code>GET</code> request to the <code>2013-04-01/geolocation</code> resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationCmdlet.ContinentCode"> <summary> <para> <para>The code for a continent geo location. Note: only continent locations have a continent code.</para><para>Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code> | <code>OC</code> | <code>NA</code> | <code>SA</code></para><para>Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code> or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationCmdlet.CountryCode"> <summary> <para> <para>The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.</para><para>The default geo location uses a <code>*</code> for the country code. All other country codes follow the ISO 3166 two-character code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationCmdlet.SubdivisionCode"> <summary> <para> <para>The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.</para><para>Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code> returns an <a>InvalidInput</a> error.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationsCmdlet"> <summary> To retrieve a list of supported geo locations, send a <code>GET</code> request to the <code>2013-04-01/geolocations</code> resource. The response to this request includes a <code>GeoLocationDetailsList</code> element with zero, one, or multiple <code>GeoLocationDetails</code> child elements. The list is sorted by country code, and then subdivision code, followed by continents at the end of the list. <para> By default, the list of geo locations is displayed on a single page. You can control the length of the page that is displayed by using the <code>MaxItems</code> parameter. If the list is truncated, <code>IsTruncated</code> will be set to <i>true</i> and a combination of <code>NextContinentCode, NextCountryCode, NextSubdivisionCode</code> will be populated. You can pass these as parameters to <code>StartContinentCode, StartCountryCode, StartSubdivisionCode</code> to control the geo location that the list begins with. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationsCmdlet.StartContinentCode"> <summary> <para> <para>The first continent code in the lexicographic ordering of geo locations that you want the <code>ListGeoLocations</code> request to list. For non-continent geo locations, this should be null.</para><para>Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code> | <code>OC</code> | <code>NA</code> | <code>SA</code></para><para>Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code> or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationsCmdlet.StartCountryCode"> <summary> <para> <para>The first country code in the lexicographic ordering of geo locations that you want the <code>ListGeoLocations</code> request to list.</para><para>The default geo location uses a <code>*</code> for the country code. All other country codes follow the ISO 3166 two-character code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationsCmdlet.StartSubdivisionCode"> <summary> <para> <para>The first subdivision code in the lexicographic ordering of geo locations that you want the <code>ListGeoLocations</code> request to list.</para><para>Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code> returns an <a>InvalidInput</a> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53GeoLocationsCmdlet.MaxItem"> <summary> <para> <para>The maximum number of geo locations you want in the response body.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53HealthCheckCmdlet"> <summary> To retrieve the health check, send a <code>GET</code> request to the <code>2013-04-01/healthcheck/<i>health check ID</i></code> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HealthCheckCmdlet.HealthCheckId"> <summary> <para> <para>The ID of the health check to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53HealthCheckCountCmdlet"> <summary> To retrieve a count of all your health checks, send a <code>GET</code> request to the <code>2013-04-01/healthcheckcount</code> resource. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53HealthCheckLastFailureReasonCmdlet"> <summary> If you want to learn why a health check is currently failing or why it failed most recently (if at all), you can get the failure reason for the most recent failure. Send a <code>GET</code> request to the <code>2013-04-01/healthcheck/<i>health check ID</i>/lastfailurereason</code> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HealthCheckLastFailureReasonCmdlet.HealthCheckId"> <summary> <para> <para>The ID of the health check for which you want to retrieve the reason for the most recent failure.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53HealthChecksCmdlet"> <summary> To retrieve a list of your health checks, send a <code>GET</code> request to the <code>2013-04-01/healthcheck</code> resource. The response to this request includes a <code>HealthChecks</code> element with zero, one, or multiple <code>HealthCheck</code> child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the <code>MaxItems</code> parameter. You can use the <code>Marker</code> parameter to control the health check that the list begins with. <note> Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HealthChecksCmdlet.Marker"> <summary> <para> <para>If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker</code> from the last response in the <code>marker</code> parameter to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HealthChecksCmdlet.MaxItem"> <summary> <para> <para>Specify the maximum number of health checks to return per page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53HealthCheckStatusCmdlet"> <summary> To retrieve the health check status, send a <code>GET</code> request to the <code>2013-04-01/healthcheck/<i>health check ID</i>/status</code> resource. You can use this call to get a health check's current status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HealthCheckStatusCmdlet.HealthCheckId"> <summary> <para> <para>The ID of the health check for which you want to retrieve the most recent status.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZoneCmdlet"> <summary> To retrieve the delegation set for a hosted zone, send a <code>GET</code> request to the <code>2013-04-01/hostedzone/<i>hosted zone ID</i></code> resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZoneCmdlet.Id"> <summary> <para> <para>The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZoneCountCmdlet"> <summary> To retrieve a count of all your hosted zones, send a <code>GET</code> request to the <code>2013-04-01/hostedzonecount</code> resource. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZonesCmdlet"> <summary> To retrieve a list of your hosted zones, send a <code>GET</code> request to the <code>2013-04-01/hostedzone</code> resource. The response to this request includes a <code>HostedZones</code> element with zero, one, or multiple <code>HostedZone</code> child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the <code>MaxItems</code> parameter. You can use the <code>Marker</code> parameter to control the hosted zone that the list begins with. <note> Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZonesCmdlet.DelegationSetId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZonesCmdlet.Marker"> <summary> <para> <para>If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker</code> from the last response in the <code>marker</code> parameter to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53HostedZonesCmdlet.MaxItem"> <summary> <para> <para>Specify the maximum number of hosted zones to return per page of results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53ResourceRecordSetCmdlet"> <summary> Imagine all the resource record sets in a zone listed out in front of you. Imagine them sorted lexicographically first by DNS name (with the labels reversed, like "com.amazon.www" for example), and secondarily, lexicographically by record type. This operation retrieves at most MaxItems resource record sets from this list, in order, starting at a position specified by the Name and Type arguments: <ul><li>If both Name and Type are omitted, this means start the results at the first RRSET in the HostedZone.</li><li>If Name is specified but Type is omitted, this means start the results at the first RRSET in the list whose name is greater than or equal to Name. </li><li>If both Name and Type are specified, this means start the results at the first RRSET in the list whose name is greater than or equal to Name and whose type is greater than or equal to Type.</li><li>It is an error to specify the Type but not the Name.</li></ul><para> Use ListResourceRecordSets to retrieve a single known record set by specifying the record set's name and type, and setting MaxItems = 1 </para><para> To retrieve all the records in a HostedZone, first pause any processes making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets without a Name and Type to get the first page of record sets. For subsequent calls, set Name and Type to the NextName and NextType values returned by the previous response. </para><para> In the presence of concurrent ChangeResourceRecordSets calls, there is no consistency of results across calls to ListResourceRecordSets. The only way to get a consistent multi-page snapshot of all RRSETs in a zone is to stop making changes while pagination is in progress. </para><para> However, the results from ListResourceRecordSets are consistent within a page. If MakeChange calls are taking place concurrently, the result of each one will either be completely visible in your results or not at all. You will not see partial changes, or changes that do not ultimately succeed. (This follows from the fact that MakeChange is atomic) </para><para> The results from ListResourceRecordSets are strongly consistent with ChangeResourceRecordSets. To be precise, if a single process makes a call to ChangeResourceRecordSets and receives a successful response, the effects of that change will be visible in a subsequent call to ListResourceRecordSets by that process. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ResourceRecordSetCmdlet.HostedZoneId"> <summary> <para> <para> The ID of the hosted zone that contains the resource record sets that you want to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ResourceRecordSetCmdlet.StartRecordIdentifier"> <summary> <para> <para><i>Weighted resource record sets only:</i> If results were truncated for a given DNS name and type, specify the value of <code>ListResourceRecordSetsResponse$NextRecordIdentifier</code> from the previous response to get the next resource record set that has the current DNS name and type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ResourceRecordSetCmdlet.StartRecordName"> <summary> <para> <para>The first name in the lexicographic ordering of domain names that you want the <code>ListResourceRecordSets</code> request to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ResourceRecordSetCmdlet.StartRecordType"> <summary> <para> <para>The DNS type at which to begin the listing of resource record sets. </para><para>Valid values: <code>A</code> | <code>AAAA</code> | <code>CNAME</code> | <code>MX</code> | <code>NS</code> | <code>PTR</code> | <code>SOA</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code></para><para>Values for Weighted Resource Record Sets: <code>A</code> | <code>AAAA</code> | <code>CNAME</code> | <code>TXT</code></para><para> Values for Regional Resource Record Sets: <code>A</code> | <code>AAAA</code> | <code>CNAME</code> | <code>TXT</code></para><para>Values for Alias Resource Record Sets: <code>A</code> | <code>AAAA</code></para><para>Constraint: Specifying <code>type</code> without specifying <code>name</code> returns an <a>InvalidInput</a> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ResourceRecordSetCmdlet.MaxItem"> <summary> <para> <para>The maximum number of records you want in the response body.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53ReusableDelegationSetCmdlet"> <summary> To retrieve the reusable delegation set, send a <code>GET</code> request to the <code>2013-04-01/delegationset/<i>delegation set ID</i></code> resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ReusableDelegationSetCmdlet.Id"> <summary> <para> <para>The ID of the reusable delegation set for which you want to get a list of the name server.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.GetR53ReusableDelegationSetsCmdlet"> <summary> To retrieve a list of your reusable delegation sets, send a <code>GET</code> request to the <code>2013-04-01/delegationset</code> resource. The response to this request includes a <code>DelegationSets</code> element with zero, one, or multiple <code>DelegationSet</code> child elements. By default, the list of delegation sets is displayed on a single page. You can control the length of the page that is displayed by using the <code>MaxItems</code> parameter. You can use the <code>Marker</code> parameter to control the delegation set that the list begins with. <note> Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ReusableDelegationSetsCmdlet.Marker"> <summary> <para> <para>If the request returned more than one page of results, submit another request and specify the value of <code>NextMarker</code> from the last response in the <code>marker</code> parameter to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53ReusableDelegationSetsCmdlet.MaxItem"> <summary> <para> <para>Specify the maximum number of reusable delegation sets to return per page of results.</para> </para> </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.R53.GetR53TagsForResourceCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53TagsForResourceCmdlet.ResourceId"> <summary> <para> <para>The ID of the resource for which you want to retrieve tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53TagsForResourceCmdlet.ResourceType"> <summary> <para> <para>The type of the resource.</para><para>- The resource type for health checks is <code>healthcheck</code>.</para><para>- The resource type for hosted zones is <code>hostedzone</code>.</para> </para> </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.R53.GetR53TagsForResourcesCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53TagsForResourcesCmdlet.ResourceId"> <summary> <para> <para>A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.GetR53TagsForResourcesCmdlet.ResourceType"> <summary> <para> <para>The type of the resources.</para><para>- The resource type for health checks is <code>healthcheck</code>.</para><para>- The resource type for hosted zones is <code>hostedzone</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet"> <summary> This action creates a new health check. <para> To create a new health check, send a <code>POST</code> request to the <code>2013-04-01/healthcheck</code> resource. The request body must include an XML document with a <code>CreateHealthCheckRequest</code> element. The response returns the <code>CreateHealthCheckResponse</code> element that contains metadata about the health check. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.CallerReference"> <summary> <para> <para>A unique string that identifies the request and that allows failed <code>CreateHealthCheck</code> requests to be retried without the risk of executing the operation twice. You must use a unique <code>CallerReference</code> string every time you create a health check. <code>CallerReference</code> can be any unique string; you might choose to use a string that identifies your project.</para><para>Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_ChildHealthCheck"> <summary> <para> <para>For a specified parent health check, a list of <code>HealthCheckId</code> values for the associated child health checks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_FailureThreshold"> <summary> <para> <para>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.</para><para>Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_FullyQualifiedDomainName"> <summary> <para> <para>Fully qualified domain name of the instance to be health checked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_HealthThreshold"> <summary> <para> <para>The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_Inverted"> <summary> <para> <para>A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but <code>Inverted</code> is <code>True</code>, then Route 53 considers the health check to be unhealthy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_IPAddress"> <summary> <para> <para>IP Address of the instance being checked. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_MeasureLatency"> <summary> <para> <para>A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_Port"> <summary> <para> <para>Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_RequestInterval"> <summary> <para> <para>The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.</para><para>Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_ResourcePath"> <summary> <para> <para>Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_SearchString"> <summary> <para> <para>A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.HealthCheckConfig_Type"> <summary> <para> <para>The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HealthCheckCmdlet.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.R53.NewR53HostedZoneCmdlet"> <summary> This action creates a new hosted zone. <para> To create a new hosted zone, send a <code>POST</code> request to the <code>2013-04-01/hostedzone</code> resource. The request body must include an XML document with a <code>CreateHostedZoneRequest</code> element. The response returns the <code>CreateHostedZoneResponse</code> element that contains metadata about the hosted zone. </para><para> Route 53 automatically creates a default SOA record and four NS records for the zone. The NS records in the hosted zone are the name servers you give your registrar to delegate your domain to. For more information about SOA and NS records, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html">NS and SOA Records that Route 53 Creates for a Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>. </para><para> When you create a zone, its initial status is <code>PENDING</code>. This means that it is not yet available on all DNS servers. The status of the zone changes to <code>INSYNC</code> when the NS and SOA records are available on all Route 53 DNS servers. </para><para> When trying to create a hosted zone using a reusable delegation set, you could specify an optional DelegationSetId, and Route53 would assign those 4 NS records for the zone, instead of alloting a new one. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HostedZoneCmdlet.CallerReference"> <summary> <para> <para>A unique string that identifies the request and that allows failed <code>CreateHostedZone</code> requests to be retried without the risk of executing the operation twice. You must use a unique <code>CallerReference</code> string every time you create a hosted zone. <code>CallerReference</code> can be any unique string; you might choose to use a string that identifies your project, such as <code>DNSMigration_01</code>.</para><para>Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HostedZoneCmdlet.HostedZoneConfig_Comment"> <summary> <para> <para>An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the <code>HostedZoneConfig</code> and <code>Comment</code> elements from the XML document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HostedZoneCmdlet.DelegationSetId"> <summary> <para> <para>The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HostedZoneCmdlet.Name"> <summary> <para> <para>The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.</para><para>This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of <code>NameServers</code> elements returned in <code>DelegationSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HostedZoneCmdlet.HostedZoneConfig_PrivateZone"> <summary> <para> <para>A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HostedZoneCmdlet.VPC_VPCId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HostedZoneCmdlet.VPC_VPCRegion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53HostedZoneCmdlet.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.R53.NewR53ReusableDelegationSetCmdlet"> <summary> This action creates a reusable delegationSet. <para> To create a new reusable delegationSet, send a <code>POST</code> request to the <code>2013-04-01/delegationset</code> resource. The request body must include an XML document with a <code>CreateReusableDelegationSetRequest</code> element. The response returns the <code>CreateReusableDelegationSetResponse</code> element that contains metadata about the delegationSet. </para><para> If the optional parameter HostedZoneId is specified, it marks the delegationSet associated with that particular hosted zone as reusable. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53ReusableDelegationSetCmdlet.CallerReference"> <summary> <para> <para>A unique string that identifies the request and that allows failed <code>CreateReusableDelegationSet</code> requests to be retried without the risk of executing the operation twice. You must use a unique <code>CallerReference</code> string every time you create a reusable delegation set. <code>CallerReference</code> can be any unique string; you might choose to use a string that identifies your project, such as <code>DNSMigration_01</code>.</para><para>Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53ReusableDelegationSetCmdlet.HostedZoneId"> <summary> <para> <para>The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.NewR53ReusableDelegationSetCmdlet.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.R53.RegisterR53VPCWithHostedZoneCmdlet"> <summary> This action associates a VPC with an hosted zone. <para> To associate a VPC with an hosted zone, send a <code>POST</code> request to the <code>2013-04-01/hostedzone/<i>hosted zone ID</i>/associatevpc</code> resource. The request body must include an XML document with a <code>AssociateVPCWithHostedZoneRequest</code> element. The response returns the <code>AssociateVPCWithHostedZoneResponse</code> element that contains <code>ChangeInfo</code> for you to track the progress of the <code>AssociateVPCWithHostedZoneRequest</code> you made. See <code>GetChange</code> operation for how to track the progress of your change. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RegisterR53VPCWithHostedZoneCmdlet.Comment"> <summary> <para> <para><i>Optional:</i> Any comments you want to include about a <code>AssociateVPCWithHostedZoneRequest</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RegisterR53VPCWithHostedZoneCmdlet.HostedZoneId"> <summary> <para> <para> The ID of the hosted zone you want to associate your VPC with.</para><para>Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RegisterR53VPCWithHostedZoneCmdlet.VPC_VPCId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RegisterR53VPCWithHostedZoneCmdlet.VPC_VPCRegion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RegisterR53VPCWithHostedZoneCmdlet.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.R53.RemoveR53HealthCheckCmdlet"> <summary> This action deletes a health check. To delete a health check, send a <code>DELETE</code> request to the <code>2013-04-01/healthcheck/<i>health check ID</i></code> resource. <important> You can delete a health check only if there are no resource record sets associated with this health check. If resource record sets are associated with this health check, you must disassociate them before you can delete your health check. If you try to delete a health check that is associated with resource record sets, Route 53 will deny your request with a <code>HealthCheckInUse</code> error. For information about disassociating the records from your health check, see <a>ChangeResourceRecordSets</a>.</important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RemoveR53HealthCheckCmdlet.HealthCheckId"> <summary> <para> <para>The ID of the health check to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RemoveR53HealthCheckCmdlet.PassThru"> <summary> Returns the value passed to the HealthCheckId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RemoveR53HealthCheckCmdlet.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.R53.RemoveR53HostedZoneCmdlet"> <summary> This action deletes a hosted zone. To delete a hosted zone, send a <code>DELETE</code> request to the <code>2013-04-01/hostedzone/<i>hosted zone ID</i></code> resource. <para> For more information about deleting a hosted zone, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DeleteHostedZone.html">Deleting a Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>. </para><important> You can delete a hosted zone only if there are no resource record sets other than the default SOA record and NS resource record sets. If your hosted zone contains other resource record sets, you must delete them before you can delete your hosted zone. If you try to delete a hosted zone that contains other resource record sets, Route 53 will deny your request with a <code>HostedZoneNotEmpty</code> error. For information about deleting records from your hosted zone, see <a>ChangeResourceRecordSets</a>.</important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RemoveR53HostedZoneCmdlet.Id"> <summary> <para> <para> The ID of the hosted zone you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RemoveR53HostedZoneCmdlet.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.R53.RemoveR53ReusableDelegationSetCmdlet"> <summary> This action deletes a reusable delegation set. To delete a reusable delegation set, send a <code>DELETE</code> request to the <code>2013-04-01/delegationset/<i>delegation set ID</i></code> resource. <important> You can delete a reusable delegation set only if there are no associated hosted zones. If your reusable delegation set contains associated hosted zones, you must delete them before you can delete your reusable delegation set. If you try to delete a reusable delegation set that contains associated hosted zones, Route 53 will deny your request with a <code>DelegationSetInUse</code> error.</important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RemoveR53ReusableDelegationSetCmdlet.Id"> <summary> <para> <para> The ID of the reusable delegation set you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RemoveR53ReusableDelegationSetCmdlet.PassThru"> <summary> Returns the value passed to the Id parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.RemoveR53ReusableDelegationSetCmdlet.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.R53.UnregisterR53VPCFromHostedZoneCmdlet"> <summary> This action disassociates a VPC from an hosted zone. <para> To disassociate a VPC to a hosted zone, send a <code>POST</code> request to the <code>2013-04-01/hostedzone/<i>hosted zone ID</i>/disassociatevpc</code> resource. The request body must include an XML document with a <code>DisassociateVPCFromHostedZoneRequest</code> element. The response returns the <code>DisassociateVPCFromHostedZoneResponse</code> element that contains <code>ChangeInfo</code> for you to track the progress of the <code>DisassociateVPCFromHostedZoneRequest</code> you made. See <code>GetChange</code> operation for how to track the progress of your change. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UnregisterR53VPCFromHostedZoneCmdlet.Comment"> <summary> <para> <para><i>Optional:</i> Any comments you want to include about a <code>DisassociateVPCFromHostedZoneRequest</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UnregisterR53VPCFromHostedZoneCmdlet.HostedZoneId"> <summary> <para> <para> The ID of the hosted zone you want to disassociate your VPC from.</para><para>Note that you cannot disassociate the last VPC from a hosted zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UnregisterR53VPCFromHostedZoneCmdlet.VPC_VPCId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UnregisterR53VPCFromHostedZoneCmdlet.VPC_VPCRegion"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UnregisterR53VPCFromHostedZoneCmdlet.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.R53.UpdateR53HealthCheckCmdlet"> <summary> This action updates an existing health check. <para> To update a health check, send a <code>POST</code> request to the <code>2013-04-01/healthcheck/<i>health check ID</i></code> resource. The request body must include an XML document with an <code>UpdateHealthCheckRequest</code> element. The response returns an <code>UpdateHealthCheckResponse</code> element, which contains metadata about the health check. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.ChildHealthCheck"> <summary> <para> <para>For a specified parent health check, a list of <code>HealthCheckId</code> values for the associated child health checks.</para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.FailureThreshold"> <summary> <para> <para>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.</para><para>Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.</para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.FullyQualifiedDomainName"> <summary> <para> <para>Fully qualified domain name of the instance to be health checked.</para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.HealthCheckId"> <summary> <para> <para>The ID of the health check to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.HealthCheckVersion"> <summary> <para> <para>Optional. When you specify a health check version, Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using <code>HealthCheckVersion</code> lets you prevent overwriting another change to the health check.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.HealthThreshold"> <summary> <para> <para>The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.</para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.Inverted"> <summary> <para> <para>A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but <code>Inverted</code> is <code>True</code>, then Route 53 considers the health check to be unhealthy.</para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.IPAddress"> <summary> <para> <para>The IP address of the resource that you want to check.</para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.Port"> <summary> <para> <para>The port on which you want Route 53 to open a connection to perform health checks.</para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.ResourcePath"> <summary> <para> <para>The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. </para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.SearchString"> <summary> <para> <para>If the value of <code>Type</code> is <code>HTTP_STR_MATCH</code> or <code>HTTP_STR_MATCH</code>, the string that you want Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. </para><para>Specify this value only if you want to change it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HealthCheckCmdlet.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.R53.UpdateR53HostedZoneCommentCmdlet"> <summary> To update the hosted zone comment, send a <code>POST</code> request to the <code>2013-04-01/hostedzone/<i>hosted zone ID</i></code> resource. The request body must include an XML document with a <code>UpdateHostedZoneCommentRequest</code> element. The response to this request includes the modified <code>HostedZone</code> element. <note> The comment can have a maximum length of 256 characters.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HostedZoneCommentCmdlet.Comment"> <summary> <para> <para>A comment about your hosted zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HostedZoneCommentCmdlet.Id"> <summary> <para> <para>The ID of the hosted zone you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53.UpdateR53HostedZoneCommentCmdlet.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="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.CleanKey(System.String)"> <summary> 'Cleans' a user-supplied S3 key to ensure it does not start with space, \ or / and all remaining partitions use / and it does not end with a space. </summary> <param name="userKeyOrPrefix">The original user key or key prefix</param> <returns>Cleaned key</returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.BucketNameFromParam(System.Object,System.String)"> <summary> Extracts a bucket name from a supplied parameter object, which should be a string or S3Bucket instance. </summary> <param name="paramValue"></param> <param name="paramName"></param> <returns></returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.BucketRegionFromParam(System.Object,System.String)"> <summary> Extracts the system name of a region for a bucket from parameter value </summary> <param name="paramValue"></param> <param name="paramName"></param> <returns></returns> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetExtraRequestFields(Amazon.S3.Transfer.TransferUtilityUploadDirectoryRequest,Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CmdletContext)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="cmdletContext"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetMetadataAndHeaders(Amazon.S3.Transfer.TransferUtilityUploadRequest,System.Collections.Hashtable,System.Collections.Hashtable)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="metadata"></param> <param name="headers"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetMetadataAndHeaders(Amazon.S3.Model.PutObjectRequest,System.Collections.Hashtable,System.Collections.Hashtable)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="metadata"></param> <param name="headers"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.S3.AmazonS3Helper.SetMetadataAndHeaders(Amazon.S3.Model.CopyObjectRequest,System.Collections.Hashtable,System.Collections.Hashtable)"> <summary> Sets metadata and headers collections for the request. </summary> <param name="request"></param> <param name="metadata"></param> <param name="headers"></param> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet"> <summary> Makes a copy of an S3 object to another S3 object or to the local file system </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.BucketName"> <summary> The name of the bucket containing the source object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.Key"> <summary> The key of the source object to copy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.VersionId"> <summary> Specifies the version of the source object to copy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.DestinationKey"> <summary> The key for the copy of the source S3 object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.DestinationBucket"> <summary> The name of the bucket that will contain the copied object. If not specified, the copy is to another S3 object in the source bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.MetadataDirective"> <summary> Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values are COPY or REPLACE. COPY is the default if not specified. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ContentType"> <summary> Sets the content type of the target object; if not specified an attempt is made to infer it using the destination or source object keys. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CannedACLName"> <summary> Specifies the canned ACL (access control list) of permissions to be applied to the S3 bucket. Please refer to <see cref="T:Amazon.S3.Model.S3CannedACL" /> for information on S3 Canned ACLs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.PublicReadOnly"> <summary> If set, applies an ACL making the bucket public with read-only permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.PublicReadWrite"> <summary> If set, applies an ACL making the bucket public with read-write permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.StandardStorage"> <summary> Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ReducedRedundancyStorage"> <summary> Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that doesn’t require the higher level of durability that S3 provides with the STANDARD storage class. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryption"> <summary> Specifies the encryption used on the server to store the content. Allowable values: None, AES256, AWSKMS. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryptionKeyManagementServiceKeyId"> <summary> Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.WebsiteRedirectLocation"> <summary> Gets and sets the WebsiteRedirectLocation property. If this is set then when a GET request is made from the S3 website endpoint a 301 HTTP status code will be returned indicating a redirect with this value as the redirect location. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.Metadata"> <summary> Metadata headers to set on the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.HeaderCollection"> <summary> Response headers to set on the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.LocalFile"> <summary> The full path to the local file that will be created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ETagToMatch"> <summary> Copies the object if its entity tag (ETag) matches the specified tag; otherwise return a PreconditionFailed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ETagToNotMatch"> <summary> Copies the object if its entity tag (ETag) is different than the specified Etag; otherwise returns an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ModifiedSinceDate"> <summary> Copies the object if it has been modified since the specified time; otherwise returns an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.UnmodifiedSinceDate"> <summary> Copies the object if it hasn't been modified since the specified time; otherwise returns a PreconditionFailed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CopySourceServerSideEncryptionCustomerMethod"> <summary> Specifies the server-side encryption algorithm used on the source object with the customer provided key. Allowable values: None or AES256. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CopySourceServerSideEncryptionCustomerProvidedKey"> <summary> Specifies base64-encoded encryption key for Amazon S3 used on the source object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.CopySourceServerSideEncryptionCustomerProvidedKeyMD5"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 used on the source object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryptionCustomerMethod"> <summary> Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.CopyS3ObjectCmdlet.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.S3.GetS3BucketCmdlet"> <summary> Retrieves one or more S3Bucket instances describing a set of buckets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketCmdlet.BucketName"> <summary> If set, returns a single S3Bucket instance mapping to the specified bucket. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet"> <summary> Retrieves S3Object instances for one or more S3 objects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.BucketName"> <summary> The name of the bucket that holds the S3 object(s). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Encoding"> <summary> Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Key"> <summary> Key value identifying a single object in S3 to return metadata for. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.KeyPrefix"> <summary> Limits the response to keys which begin with the indicated prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders. If not specified, all objects are processed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Marker"> <summary> Indicates where in the bucket to begin listing. The list will only include keys that occur lexicographically after marker. This is convenient for pagination: to get the next page of results use the last key of the current page as the marker. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.MaxKey"> <summary> <para> The maximum number of keys to return (the cmdlet might return fewer than this many keys, but will not return more). </para> <para> Amazon S3 limits API calls to retrieve keys to a maximum of 1000 keys per call. If this parameter is specified and exceeds this limit the cmdlet will make multiple calls in batches of 1000 to retrieve up to the specified number of keys (or less, depending on how many objects the bucket contains). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectCmdlet.Delimiter"> <summary> Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet"> <summary> Creates a new bucket with the supplied name and permissions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.BucketName"> <summary> The name that will be given to the new bucket. This name needs to be unique across Amazon S3. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.CannedACLName"> <summary> Specifies the name of the canned ACL (access control list) of permissions to be applied to the S3 bucket. Please refer to <see cref="T:Amazon.S3.Model.S3CannedACL" /> for information on S3 Canned ACLs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.PublicReadOnly"> <summary> If set, applies an ACL making the bucket public with read-only permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.PublicReadWrite"> <summary> If set, applies an ACL making the bucket public with read-write permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.NewS3BucketCmdlet.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.S3.ReadS3ObjectCmdlet"> <summary> Downloads an S3 object, optionally including sub-objects, to a local file or folder location. Returns a FileInfo or DirectoryInfo instance to the downloaded file (or specified containing folder). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.BucketName"> <summary> Name of the bucket that holds the content to be downloaded </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.Key"> <summary> The key that identifies the single object in S3. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.File"> <summary> The full path to the local file that will be created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.Version"> <summary> If specified, the specific version of the S3 object is returned. </summary> </member> <!-- Badly formed XML comment ignored for member "P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.KeyPrefix" --> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.Folder"> <summary> The full path to a local folder; all downloaded content will be placed under this folder, with subfolders maintaining the S3 object key hierarchies. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ModifiedSinceDate"> <summary> If specified, only objects that have been modified since this date will be downloaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.UnmodifiedSinceDate"> <summary> If specified, only objects that have not been modified since this date will be downloaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ServerSideEncryptionCustomerMethod"> <summary> Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> Specifies base64-encoded encryption key for Amazon S3 to use to decrypt the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.ReadS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="T:Amazon.PowerShell.Utils.ProgressTracker`1"> <summary> Class that tracks progress of an activity through event callbacks and reports the activity to a ProgressRunner. </summary> <typeparam name="T"></typeparam> </member> <member name="T:Amazon.PowerShell.Utils.ProgressTracker"> <summary> Base, non-generic class for tracking an activity and reporting the progress. </summary> </member> <member name="M:Amazon.PowerShell.Utils.ProgressTracker.#ctor(Amazon.PowerShell.Utils.ProgressRunner)"> <summary> Constructs a tracker to work with a given ProgressRunner. The subscribe action must subscribe the specified handler to the even the tracker will be listening to. </summary> <param name="runner"></param> </member> <member name="P:Amazon.PowerShell.Utils.ProgressTracker.Activity"> <summary> Name of the activity. </summary> </member> <member name="M:Amazon.PowerShell.Utils.ProgressTracker`1.#ctor(Amazon.PowerShell.Utils.ProgressRunner,System.Action{System.EventHandler{`0}})"> <summary> Constructs a tracker to work with a given ProgressRunner. The subscribe action must subscribe the specified handler to the even the tracker will be listening to. </summary> <param name="runner"></param> <param name="subscribe"></param> </member> <member name="M:Amazon.PowerShell.Utils.ProgressTracker`1.ReportProgress(`0)"> <summary> Abstract method to process event data. Must be overriden by subclass. If progress has changed, should invoke ReportProgress to update shell. </summary> <param name="args"></param> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet"> <summary> Deletes an S3 bucket, optionally deleting remaining bucket content first (non-empty buckets cannot be deleted). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet.BucketName"> <summary> The name of the bucket to be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet.DeleteBucketContent"> <summary> <para> If set, all remaining objects and/or object versions in the bucket are deleted proir to the bucket itself being deleted. </para> <para>Default: Off.</para> <para> Buckets that contain objects cannot be deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketCmdlet.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.S3.RemoveS3MultipartUploadsCmdlet"> <summary> Aborts multipart uploads. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3MultipartUploadsCmdlet.BucketName"> <summary> The name of the bucket containing multipart uploads. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3MultipartUploadsCmdlet.InitiatedDate"> <summary> The date before which the multipart uploads were initiated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3MultipartUploadsCmdlet.DaysBefore"> <summary> The number of days ago that the multipart uploads were initiated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3MultipartUploadsCmdlet.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.S3.RemoveS3ObjectCmdlet"> <summary> Deletes the specified object, object version or set of objects from S3. The DeleteObject operation removes the specified object from Amazon S3. Once deleted, there is no method to restore or undelete an object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.BucketName"> <summary> The name of the bucket containing the object(s) to be removed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.Key"> <summary> Key value identifying a single object in S3 to remove. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.VersionId"> <summary> If specified, the specific version of the S3 object is removed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.VersionKey"> <summary> Collection of KeyVersion objects describing the S3 objects to be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.InputObject"> <summary> Collection of S3Object instances describing the S3 objects to be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.KeyCollection"> <summary> Collection of key names describing the S3 objects to be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.ReportErrorsOnly"> <summary> <para> If set when deleting multiple objects the service response will include only those keys for objects on which the delete operation failed. By default this switch is not set and keys for both successful multi-object deletes and failures are returned in the response. </para> <para> This parameter is used only when deleting multiple objects using the <code>-KeyCollection</code> parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.SerialNumber"> <summary> <para> Specifies the serial number of the multi-factor authentication device associated with your AWS Account. </para> <para> This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.AuthenticationValue"> <summary> <para> Specifies the current token/code displayed on the multi-factor authentication device associated with your AWS Account. </para> <para> This is a required property for this request if:<br /> 1. EnableMfaDelete was configured on the bucket containing this object's version.<br /> 2. You are deleting an object's version </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3ObjectCmdlet.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.S3.SetS3ACLCmdlet"> <summary> Sets an S3AccessControlList on the specified bucket or object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.BucketName"> <summary> The name of the bucket. If an object key is not specified, the ACLs are applied to the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.Key"> <summary> The key of an S3 object. If not specified, the ACLs are applied to the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.CannedACLName"> <summary> Specifies the canned ACL (access control list) of permissions to be applied to the S3 bucket. Please refer to <see cref="T:Amazon.S3.Model.S3CannedACL" /> for information on S3 Canned ACLs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.PublicReadOnly"> <summary> If set, applies an ACL making the bucket public with read-only permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.PublicReadWrite"> <summary> If set, applies an ACL making the bucket public with read-write permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.OwnerId"> <summary> The unique identifier of the bucket owner. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.OwnerDisplayName"> <summary> The display name of the bucket owner. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.Grant"> <summary> A collection of grants, where each Grant is a Grantee and a Permission. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.VersionId"> <summary> If set and an object key has been specified, the ACLs are applied to the specific version of the object. This property is ignored if the ACL is to be set on a Bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.SetS3ACLCmdlet.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.S3.TestS3BucketCmdlet"> <summary> Tests that an S3 Bucket exists </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.TestS3BucketCmdlet.BucketName"> <summary> The name of the bucket to test existence and access. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet"> <summary> <para> Uploads a local file, text content or a folder hierarchy of files to Amazon S3, placing them into the specified bucket using the specified key (single object) or key prefix (multiple objects). </para> <para> If you are uploading large files, Write-S3Object cmdlet will use multipart upload to fulfill the request. If a multipart upload is interrupted, Write-S3Object cmdlet will attempt to abort the multipart upload. Under certain circumstances (network outage, power failure, etc.), Write-S3Object cmdlet will not be able to abort the multipart upload. In this case, in order to stop getting charged for the storage of uploaded parts, you should manually invoke the Remove-S3MultipartUploads to abort the incomplete multipart uploads. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.BucketName"> <summary> The name of the bucket that will hold the uploaded content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Key"> <summary> The key that will be used to identify the object in S3. If the -File parameter is specified, -Key is optional and the object key can be inferred from the filename value supplied to the -File parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.File"> <summary> The full path to the local file to be uploaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Content"> <summary> Specifies text content that will be used to set the content of the object in S3. Use a here-string to specify multiple lines of text. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Stream"> <summary> The stream to be uploaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.KeyPrefix"> <summary> <para> The common key prefix that will be used for the objects uploaded to S3. Use this parameter when uploading multiple objects. Each object's final key will be of the form 'keyprefix/filename'. </para> <para> To indicate that all content should be uploaded to the root of the bucket, specify a KeyPrefix of '\' or '/'. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Folder"> <summary> The full path to a local folder; all content in the folder will be uploaded to the specified bucket and key. Sub-folders in the folder will only be uploaded if the Recurse switch is specified. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Recurse"> <summary> If set, all sub-folders beneath the folder set in LocalFolder will also be uploaded. The folder structure will be mirrored in S3. Defaults off [false]. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.SearchPattern"> <summary> The search pattern used to determine which files in the directory are uploaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.CannedACLName"> <summary> Specifies the name of the canned ACL (access control list) of permissions to be applied to the S3 object(s). Please refer to <see cref="T:Amazon.S3.Model.S3CannedACL" /> for information on S3 Canned ACLs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.PublicReadOnly"> <summary> If set, applies an ACL making the S3 object(s) public with read-only permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.PublicReadWrite"> <summary> If set, applies an ACL making the S3 object(s) public with read-write permissions </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ContentType"> <summary> Specifies the MIME type of the content being uploaded. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.StandardStorage"> <summary> Specifies the STANDARD storage class, which is the default storage class for S3 objects. Provides a 99.999999999% durability guarantee. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ReducedRedundancyStorage"> <summary> Specifies S3 should use REDUCED_REDUNDANCY storage class for the object. This provides a reduced (99.99%) durability guarantee at a lower cost as compared to the STANDARD storage class. Use this storage class for non-mission critical data or for data that doesn’t require the higher level of durability that S3 provides with the STANDARD storage class. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryption"> <summary> Specifies the encryption used on the server to store the content. Allowable values: None, AES256, AWSKMS. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryptionKeyManagementServiceKeyId"> <summary> Specifies the AWS KMS key for Amazon S3 to use to encrypt the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryptionCustomerMethod"> <summary> Specifies the server-side encryption algorithm to be used with the customer provided key. Allowable values: None or AES256. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> Specifies base64-encoded encryption key for Amazon S3 to use to encrypt the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> Specifies base64-encoded MD5 of the encryption key for Amazon S3 to use to decrypt the object. This field is optional, the SDK will calculate the MD5 if this is not set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.Metadata"> <summary> Metadata headers to set on the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.HeaderCollection"> <summary> Response headers to set on the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.ConcurrentServiceRequest"> <summary> This property determines how many active threads will be used to upload the file . This property is only applicable if the file being uploaded is larger than 16 MB, in which case TransferUtility is used to upload multiple parts in parallel. The default value is 10. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3ObjectCmdlet.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.S3.GetS3ACLCmdlet"> <summary> Gets the access control policy for the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ACLCmdlet.BucketName"> <summary> <para> The name of the bucket to be queried or containing the object to be queried. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ACLCmdlet.Key"> <summary> <para> The key of the S3 object to be queried. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ACLCmdlet.VersionId"> <summary> <para> VersionId used to reference a specific version of the object. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLocationCmdlet"> <summary> Returns the region the bucket resides in. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLocationCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLoggingCmdlet"> <summary> Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketLoggingCmdlet.BucketName"> <summary> <para> The name of the bucket to query. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketNotificationCmdlet"> <summary> Return the notification configuration of a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketNotificationCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyCmdlet"> <summary> Returns the policy of a specified bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketPolicyCmdlet.BucketName"> <summary> <para> The name of the bucket. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketReplicationCmdlet"> <summary> Retrieves the replication configuration for the given Amazon S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketReplicationCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketRequestPaymentCmdlet"> <summary> Returns the request payment configuration of a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketRequestPaymentCmdlet.BucketName"> <summary> <para> The name of the bucket. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketTaggingCmdlet"> <summary> Returns the tag set associated with the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketTaggingCmdlet.BucketName"> <summary> <para> The name of the bucket to be queried. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketVersioningCmdlet"> <summary> Returns the versioning state of a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketVersioningCmdlet.BucketName"> <summary> <para> The name of the bucket to be queried. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3BucketWebsiteCmdlet"> <summary> Returns the website configuration for a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3BucketWebsiteCmdlet.BucketName"> <summary> <para> The name of the bucket to be queried. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3CORSConfigurationCmdlet"> <summary> Returns the cors configuration for the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3CORSConfigurationCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3LifecycleConfigurationCmdlet"> <summary> Returns the lifecycle configuration information set on the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3LifecycleConfigurationCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet"> <summary> The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.BucketName"> <summary> <para> The name of the bucket that contains the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.EtagToMatch"> <summary> <para> ETag to be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.EtagToNotMatch"> <summary> <para> ETag that should not be matched as a pre-condition for returning the object, otherwise a PreconditionFailed signal is returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.Key"> <summary> <para> The key of the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ModifiedSinceDate"> <summary> <para> Returns the object only if it has been modified since the specified time, otherwise returns a PreconditionFailed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ServerSideEncryptionCustomerMethod"> <summary> <para> The Server-side encryption algorithm to be used with the customer provided key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ServerSideEncryptionCustomerProvidedKey"> <summary> <para> The base64-encoded encryption key for Amazon S3 to use to decrypt the object <para>Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide.</para><para>When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you.</para><para>Important: Amazon S3 does not store the encryption key you provide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.ServerSideEncryptionCustomerProvidedKeyMD5"> <summary> <para> The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.UnmodifiedSinceDate"> <summary> <para> Returns the object only if it has not been modified since the specified time, otherwise returns a PreconditionFailed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3ObjectMetadataCmdlet.VersionId"> <summary> <para> VersionId used to reference a specific version of the object. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet"> <summary> Create a signed URL allowing access to a resource that would usually require authentication. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.BucketName"> <summary> <para> The name of the bucket to create a pre-signed url to, or containing the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_CacheControl"> <summary> <para> CacheControl header value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_ContentDisposition"> <summary> <para> The ContentDisposition header value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_ContentEncoding"> <summary> <para> The ContentEncoding header value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_ContentLanguage"> <summary> <para> ContentLanguage header value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ContentType"> <summary> <para> A standard MIME type describing the format of the object data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_ContentType"> <summary> <para> A standard MIME type describing the format of the object data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.Expire"> <summary> <para> The expiry date and time for the pre-signed url. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ResponseHeaderOverrides_Expire"> <summary> <para> Expiry header value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.Key"> <summary> <para> The key to the object for which a pre-signed url should be created. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.Protocol"> <summary> <para> The requested protocol (http/https) for the pre-signed url. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ServerSideEncryptionCustomerMethod"> <summary> <para> The Server-side encryption algorithm to be used with the customer provided key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ServerSideEncryptionKeyManagementServiceKeyId"> <summary> <para> The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.ServerSideEncryptionMethod"> <summary> <para> Specifies the encryption used on the server to store the content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.Verb"> <summary> <para> The verb for the pre-signed url. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3PreSignedURLCmdlet.VersionId"> <summary> <para> Version id for the object that the pre-signed url will reference. If not set, the url will reference the latest version of the object. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet"> <summary> Returns metadata about all of the versions of objects in a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.BucketName"> <summary> <para> The name of the bucket containing the objects. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.Encoding"> <summary> <para> Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.KeyMarker"> <summary> <para> Specifies the key to start with when listing objects in a bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.VersionIdMarker"> <summary> <para> Specifies the object version you want to start listing from. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.Delimiter"> <summary> <para> A delimiter is a character you use to group keys. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.MaxKey"> <summary> <para> Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.GetS3VersionCmdlet.Prefix"> <summary> <para> Limits the response to keys that begin with the specified prefix. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet"> <summary> Deletes the policy from the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet.BucketName"> <summary> <para> The bucket on which the policy is to be deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketPolicyCmdlet.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.S3.RemoveS3BucketReplicationCmdlet"> <summary> Deletes the replication configuration for the given Amazon S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketReplicationCmdlet.BucketName"> <summary> <para> The bucket on which the replication is to be deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketReplicationCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketReplicationCmdlet.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.S3.RemoveS3BucketTaggingCmdlet"> <summary> Deletes the tags from the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketTaggingCmdlet.BucketName"> <summary> <para> The name of the bucket on which the tag set is to be removed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketTaggingCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketTaggingCmdlet.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.S3.RemoveS3BucketWebsiteCmdlet"> <summary> This operation removes the website configuration from the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketWebsiteCmdlet.BucketName"> <summary> <para> The name of the bucket on which website configuration is to be removed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketWebsiteCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3BucketWebsiteCmdlet.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.S3.RemoveS3CORSConfigurationCmdlet"> <summary> Deletes the cors configuration information set for the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3CORSConfigurationCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3CORSConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3CORSConfigurationCmdlet.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.S3.RemoveS3LifecycleConfigurationCmdlet"> <summary> Deletes the lifecycle configuration from the bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3LifecycleConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket on which the lifecycle configuration is to be deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3LifecycleConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RemoveS3LifecycleConfigurationCmdlet.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.S3.RestoreS3ObjectCmdlet"> <summary> Restores an archived copy of an object back into Amazon S3 </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.CopyLifetimeInDays"> <summary> <para> Lifetime of the active copy in days </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.Key"> <summary> <para> This key indicates the S3 object to restore. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.VersionId"> <summary> <para> VersionId used to reference a specific version of the object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.RestoreS3ObjectCmdlet.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.S3.WriteS3BucketLoggingCmdlet"> <summary> Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.LoggingConfig_Grant"> <summary> <para> A collection of grants. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.LoggingConfig_TargetBucketName"> <summary> <para> Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.LoggingConfig_TargetPrefix"> <summary> <para> This element lets you specify a prefix for the keys that the log files will be stored under. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketLoggingCmdlet.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.S3.WriteS3BucketNotificationCmdlet"> <summary> Enables notifications of specified events for a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.BucketName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.LambdaFunctionConfiguration"> <summary> <para> LambdaFunctionConfigurations are configuration for Amazon S3 events to be sent to an Amazon Lambda cloud function. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.QueueConfiguration"> <summary> <para> QueueConfigurations are configuration for Amazon S3 events to be sent to Amazon SQS queues. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.TopicConfiguration"> <summary> <para> TopicConfigurations are configuration for Amazon S3 events to be sent to Amazon SNS topics. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketNotificationCmdlet.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.S3.WriteS3BucketPolicyCmdlet"> <summary> Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.BucketName"> <summary> <para> The name of the bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.ContentMD5"> <summary> <para> The base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.Policy"> <summary> <para> The bucket policy as a JSON document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketPolicyCmdlet.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.S3.WriteS3BucketReplicationCmdlet"> <summary> Sets a replication configuration for the Amazon S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.BucketName"> <summary> <para> The name of the bucket to have the replication configuration applied. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.Configuration_Role"> <summary> <para> Indicates the ARN of the role to assume. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.Configuration_Rule"> <summary> <para> Replication rules </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketReplicationCmdlet.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.S3.WriteS3BucketRequestPaymentCmdlet"> <summary> Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.BucketName"> <summary> <para> The name of the bucket to set payment config. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.RequestPaymentConfiguration_Payer"> <summary> <para> Specifies who pays for the download and request fees. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketRequestPaymentCmdlet.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.S3.WriteS3BucketTaggingCmdlet"> <summary> Sets the tags for a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.BucketName"> <summary> <para> The name of the bucket to apply the tags to. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.TagSet"> <summary> <para> The collection of tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.PassThru"> <summary> Returns the collection of Tag objects that were added. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketTaggingCmdlet.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.S3.WriteS3BucketVersioningCmdlet"> <summary> Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.MfaCodes_AuthenticationValue"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.BucketName"> <summary> <para> The name of the bucket to be updated. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.VersioningConfig_EnableMfaDelete"> <summary> <para> Specifies whether MFA Delete is enabled on this S3 Bucket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.MfaCodes_SerialNumber"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.VersioningConfig_Status"> <summary> <para> Versioning status for the bucket. Accepted values: Off, Enabled, Suspended. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketVersioningCmdlet.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.S3.WriteS3BucketWebsiteCmdlet"> <summary> Set the website configuration for a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.BucketName"> <summary> <para> The name of the bucket to apply the configuration to. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.WebsiteConfiguration_ErrorDocument"> <summary> <para> The ErrorDocument value, an object key name to use when a 4XX class error occurs. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_HostName"> <summary> <para> Name of the host where requests will be redirected. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_HttpRedirectCode"> <summary> <para> The HTTP redirect code to use on the response. Not required if one of the siblings is present. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.WebsiteConfiguration_IndexDocumentSuffix"> <summary> <para> <para>This value is a suffix that is appended to a request that is for a "directory" on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html)</para><para>The suffix must not be empty and must not include a slash character.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_Protocol"> <summary> <para> Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_ReplaceKeyPrefixWith"> <summary> <para> The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.RedirectAllRequestsTo_ReplaceKeyWith"> <summary> <para> The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.WebsiteConfiguration_RoutingRule"> <summary> <para> The list of routing rules that can be used for configuring redirects if certain conditions are meet. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3BucketWebsiteCmdlet.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.S3.WriteS3CORSConfigurationCmdlet"> <summary> Sets the cors configuration for a bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket to have the CORS configuration applied. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.Configuration_Rule"> <summary> <para> The collection of rules in this configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3CORSConfigurationCmdlet.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.S3.WriteS3LifecycleConfigurationCmdlet"> <summary> Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.BucketName"> <summary> <para> The name of the bucket to have the lifecycle configuration applied. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.Configuration_Rule"> <summary> <para> These rules defined the lifecycle configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the BucketName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.S3.WriteS3LifecycleConfigurationCmdlet.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.STS.UseSTSWebIdentityRoleCmdlet"> <summary> <para> Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Login with Amazon, Facebook, or Google. <c>AssumeRoleWithWebIdentity</c> is an API call that does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application or by deploying server-based proxy services that use long-term AWS credentials. For more information, see Creating a Mobile Application with Third-Party Sign-In in <i>AWS Security Token Service</i> . </para><para> The temporary security credentials consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling <c>AssumeRoleWithWebIdentity</c> , which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour. </para><para> The temporary security credentials that are returned from the <c>AssumeRoleWithWebIdentity</c> response have the permissions that are associated with the access policy of the role being assumed and any policies that are associated with the AWS resource being accessed. You can further restrict the permissions of the temporary security credentials by passing a policy in the request. The resulting permissions are an intersection of both policies. The role's access policy and the policy that you passed are evaluated when calls to AWS service APIs are made using the temporary security credentials. </para><para> Before your application can call <c>AssumeRoleWithWebIdentity</c> , you must have an identity token from an identity provider and create a role that the application can assume. Typically, to get an identity token, you need to register your application with the identity provider and get a unique application ID from that provider. Also, when you create the role that the application assumes, you must specify the registered identity provider as a principal (establish trust with the identity provider). For more information, see Creating Temporary Security Credentials for Mobile Apps Using Third-Party Identity Providers. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSWebIdentityRoleCmdlet.RoleArn"> <summary> <para> The Amazon Resource Name (ARN) of the role that the caller is assuming. <para><b>Constraints:</b><list type="definition"><item><term>Length</term><description>20 - 2048</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSWebIdentityRoleCmdlet.RoleSessionName"> <summary> <para> An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the <c>AssumedRoleUser</c> response element. <para><b>Constraints:</b><list type="definition"><item><term>Length</term><description>2 - 32</description></item><item><term>Pattern</term><description>[\w+=,.@-]*</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSWebIdentityRoleCmdlet.WebIdentityToken"> <summary> <para> The OAuth 2.0 access token or OpenID Connect id token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an <c>AssumeRoleWithWebIdentity</c> call. <para><b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSWebIdentityRoleCmdlet.ProviderId"> <summary> <para> Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect id tokens, such as <c>accounts.google.com</c>. This is the fully-qualified host component of the domain name of the identity provider. Do not include URL schemes and port numbers. Currently, <c>www.amazon.com</c> and <c>graph.facebook.com</c> are supported. <para><b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSWebIdentityRoleCmdlet.Policy"> <summary> <para> A supplemental policy that is associated with the temporary security credentials from the <c>AssumeRoleWithWebIdentity</c> call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials. <para><b>Constraints:</b><list type="definition"><item><term>Length</term><description>1 - 2048</description></item><item><term>Pattern</term><description>[\u0009\u000A\u000D\u0020-\u00FF]+</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSWebIdentityRoleCmdlet.Duration"> <summary> <para> The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. <para><b>Constraints:</b><list type="definition"><item><term>Range</term><description>900 - 129600</description></item></list></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSWebIdentityRoleCmdlet.Region"> <summary> The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud has its own endpoint. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.STS.ConvertSTSAuthorizationMessageCmdlet"> <summary> Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. <para> For example, if a user is not authorized to perform an action that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure. </para><note> Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code. </note><para> The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action. </para><para> The decoded message includes the following type of information: </para><ul><li>Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccessPolicyLanguage_EvaluationLogic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in <i>Using IAM</i>. </li><li>The principal who made the request.</li><li>The requested action.</li><li>The requested resource.</li><li>The values of condition keys in the context of the user's request.</li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.ConvertSTSAuthorizationMessageCmdlet.EncodedMessage"> <summary> <para> <para>The encoded message that was returned with the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.ConvertSTSAuthorizationMessageCmdlet.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.STS.GetSTSFederationTokenCmdlet"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the <code>GetFederationToken</code> action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. <note><para> If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingWIF.html">Creating Temporary Security Credentials for Mobile Apps Using Identity Providers</a>. </para></note><para> The <code>GetFederationToken</code> action must be called by using the long-term AWS security credentials of an IAM user. You can also call <code>GetFederationToken</code> using the security credentials of an AWS account (root), but this is not recommended. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources they need access to. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html">IAM Best Practices</a> in <i>Using IAM</i>. </para><para> The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, between 900 seconds (15 minutes) and 129600 seconds (36 hours). Temporary credentials that are obtained by using AWS account (root) credentials have a maximum duration of 3600 seconds (1 hour) </para><para><b>Permissions</b></para><para> The permissions for the temporary security credentials returned by <code>GetFederationToken</code> are determined by a combination of the following: </para><ul><li>The policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>.</li><li>The policy that is passed as a parameter in the call.</li></ul><para> The passed policy is attached to the temporary security credentials that result from the <code>GetFederationToken</code> API call--that is, to the <i>federated user</i>. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call <code>GetFederationToken</code>. AWS allows the federated user's request only when both the federated user <i><b>and</b></i> the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. </para><para> A typical use case is that the permissions of the IAM user whose credentials are used to call <code>GetFederationToken</code> are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user. </para><para> If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </para><para> For more information about how permissions work, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-get-federation-token.html">Permissions for GetFederationToken</a>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingFedTokens.html">Creating Temporary Credentials to Enable Access for Federated Users</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.GetSTSFederationTokenCmdlet.DurationInSeconds"> <summary> <para> <para>The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.GetSTSFederationTokenCmdlet.Name"> <summary> <para> <para>The name of the federated user. The name is used as an identifier for the temporary security credentials (such as <code>Bob</code>). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.GetSTSFederationTokenCmdlet.Policy"> <summary> <para> <para>An IAM policy in JSON format that is passed with the <code>GetFederationToken</code> call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.</para><para>If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </para><note>The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </note><para>For more information about how permissions work, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-get-federation-token.html">Permissions for GetFederationToken</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.STS.GetSTSSessionTokenCmdlet"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, between 900 seconds (15 minutes) and 129600 seconds (36 hours); credentials that are created by using account credentials have a maximum duration of 3600 seconds (1 hour). </para><note><para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para></note><para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para><para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSessionTokens.html" target="_blank">Creating Temporary Credentials to Enable Access for IAM Users</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.GetSTSSessionTokenCmdlet.DurationInSeconds"> <summary> <para> <para>The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.GetSTSSessionTokenCmdlet.SerialNumber"> <summary> <para> <para>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.GetSTSSessionTokenCmdlet.TokenCode"> <summary> <para> <para>The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use <code>AssumeRole</code> for cross-account access or federation. <para><b>Important:</b> You cannot call <code>AssumeRole</code> by using AWS account credentials; access will be denied. You must use IAM user credentials or temporary security credentials to call <code>AssumeRole</code>. </para><para> For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">IAM Roles (Delegation and Federation)</a> in <i>Using IAM</i>. </para><para> For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call <code>AssumeRole</code> (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/STSUseCases.html">Scenarios for Granting Temporary Access</a> in <i>Using Temporary Security Credentials</i>. </para><para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). The default is 1 hour. </para><para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in <i>Using Temporary Security Credentials</i>. </para><para> To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. You must also have a policy that allows you to call <code>sts:AssumeRole</code>. </para><para><b>Using MFA with AssumeRole</b></para><para> You can optionally include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. </para><para><code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code></para><para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in <i>Using IAM</i> guide. </para><para> To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA devices produces. </para><member name="RoleArn" target="arnType"></member><member name="RoleSessionName" target="userNameType"></member><member name="Policy" target="sessionPolicyDocumentType"></member><member name="DurationSeconds" target="roleDurationSecondsType"></member><member name="ExternalId" target="externalIdType"></member> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet.DurationInSeconds"> <summary> <para> <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet.ExternalId"> <summary> <para> <para>A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/sts-delegating-externalid.html">How to Use External ID When Granting Access to Your AWS Resources</a> in <i>Using Temporary Security Credentials</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet.Policy"> <summary> <para> <para>An IAM policy in JSON format.</para><para>This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, <i>and</i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in <i>Using Temporary Security Credentials</i>. </para><note>The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the role to assume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet.RoleSessionName"> <summary> <para> <para>An identifier for the assumed role session. </para><para>Use the role session name to uniquely identity a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet.SerialNumber"> <summary> <para> <para>The identification number of the MFA device that is associated with the user who is making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet.TokenCode"> <summary> <para> <para>The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or expired, the <code>AssumeRole</code> call returns an "access denied" error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleCmdlet.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.STS.UseSTSRoleWithSAMLCmdlet"> <summary> Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. <para> The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithSAML</code>, which can be up to 3600 seconds (1 hour) or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. </para><note>The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified. </note><para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html">Permissions for AssumeRoleWithSAML</a> in <i>Using Temporary Security Credentials</i>. </para><para> Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy. </para><para> Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. </para><para> For more information, see the following resources: </para><ul><li><a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html">Creating Temporary Security Credentials for SAML Federation</a>. </li><li><a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/idp-managing-identityproviders.html">SAML Providers</a> in <i>Using IAM</i>. </li><li><a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and Claims</a> in <i>Using IAM</i>. </li><li><a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml.html">Creating a Role for SAML-Based Federation</a> in <i>Using IAM</i>. </li></ul><member name="RoleArn" target="arnType"></member><member name="SAMLAssertion" target="SAMLAssertionType"></member><member name="Policy" target="sessionPolicyDocumentType"></member><member name="DurationSeconds" target="roleDurationSecondsType"></member> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleWithSAMLCmdlet.DurationInSeconds"> <summary> <para> <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value. The actual expiration time is whichever value is shorter. </para><note>The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleWithSAMLCmdlet.Policy"> <summary> <para> <para>An IAM policy in JSON format.</para><para>The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-assume-role.html">Permissions for AssumeRoleWithSAML</a> in <i>Using Temporary Security Credentials</i>. </para><note>The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleWithSAMLCmdlet.PrincipalArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleWithSAMLCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the role that the caller is assuming.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleWithSAMLCmdlet.SAMLAssertion"> <summary> <para> <para>The base-64 encoded SAML authentication response provided by the IdP.</para><para>For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and Adding Claims</a> in the <i>Using IAM</i> guide. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.STS.UseSTSRoleWithSAMLCmdlet.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.SES.ConfirmSESDomainDkimCmdlet"> <summary> Returns a set of DKIM tokens for a domain. DKIM <i>tokens</i> are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. <para> This action is throttled at one request per second. </para><para> To enable or disable Easy DKIM signing for a domain, use the <code>SetIdentityDkimEnabled</code> action. </para><para> For more information about creating DNS records using DKIM tokens, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESDomainDkimCmdlet.Domain"> <summary> <para> <para>The name of the domain to be verified for Easy DKIM signing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESDomainDkimCmdlet.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.SES.ConfirmSESDomainIdentityCmdlet"> <summary> Verifies a domain. <para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESDomainIdentityCmdlet.Domain"> <summary> <para> <para>The domain to be verified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESDomainIdentityCmdlet.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.SES.ConfirmSESEmailAddressCmdlet"> <summary> Verifies an email address. This action causes a confirmation email message to be sent to the specified address. <important>The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.</important><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESEmailAddressCmdlet.EmailAddress"> <summary> <para> <para>The email address to be verified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESEmailAddressCmdlet.PassThru"> <summary> Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESEmailAddressCmdlet.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.SES.ConfirmSESEmailIdentityCmdlet"> <summary> Verifies an email address. This action causes a confirmation email message to be sent to the specified address. <para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESEmailIdentityCmdlet.EmailAddress"> <summary> <para> <para>The email address to be verified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESEmailIdentityCmdlet.PassThru"> <summary> Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.ConfirmSESEmailIdentityCmdlet.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.SES.CopySESReceiptRuleSetCmdlet"> <summary> Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set. <para> For information about setting up rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.CopySESReceiptRuleSetCmdlet.OriginalRuleSetName"> <summary> <para> <para>The name of the rule set to clone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.CopySESReceiptRuleSetCmdlet.RuleSetName"> <summary> <para> <para>The name of the rule set to create. The name must:</para><ul><li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</li><li>Start and end with a letter or number.</li><li>Contain less than 64 characters.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.CopySESReceiptRuleSetCmdlet.PassThru"> <summary> Returns the value passed to the OriginalRuleSetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.CopySESReceiptRuleSetCmdlet.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.SES.GetSESActiveReceiptRuleSetCmdlet"> <summary> Returns the metadata and receipt rules for the receipt rule set that is currently active. <para> For information about setting up receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityCmdlet"> <summary> Returns a list containing all of the identities (email addresses and domains) for a specific AWS Account, regardless of verification status. <para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityCmdlet.IdentityType"> <summary> <para> <para>The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityCmdlet.MaxItem"> <summary> <para> <para>The maximum number of identities per page. Possible values are 1-1000 inclusive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityCmdlet.NextToken"> <summary> <para> <para>The token to use for pagination.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityDkimAttributeCmdlet"> <summary> Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published. <para> This action takes a list of identities as input and returns the following information for each: </para><ul><li>Whether Easy DKIM signing is enabled or disabled.</li><li>A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.</li><li>Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.</li></ul><para> This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time. </para><para> For more information about creating DNS records using DKIM tokens, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html">Amazon SES Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityDkimAttributeCmdlet.Identity"> <summary> <para> <para>A list of one or more verified identities - email addresses, domains, or both.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityNotificationAttributeCmdlet"> <summary> Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. <para> This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time. </para><para> For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityNotificationAttributeCmdlet.Identity"> <summary> <para> <para>A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityPolicyCmdlet"> <summary> Returns the requested sending authorization policies for the given identity (email address or domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note><para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityPolicyCmdlet.Identity"> <summary> <para> <para>The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</para><para>To successfully call this API, you must own the identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityPolicyCmdlet.PolicyName"> <summary> <para> <para>A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use <code>ListIdentityPolicies</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityPolicyListCmdlet"> <summary> Returns a list of sending authorization policies that are attached to the given identity (email address or domain). This API returns only a list. If you want the actual policy content, you can use <code>GetIdentityPolicies</code>. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note><para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityPolicyListCmdlet.Identity"> <summary> <para> <para>The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</para><para>To successfully call this API, you must own the identity.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityVerificationAttributeCmdlet"> <summary> Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity. <para> This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESIdentityVerificationAttributeCmdlet.Identity"> <summary> <para> <para>A list of identities.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESReceiptFiltersCmdlet"> <summary> Lists the IP address filters associated with your account. <para> For information about managing IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESReceiptRuleCmdlet"> <summary> Returns the details of the specified receipt rule. <para> For information about setting up receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESReceiptRuleCmdlet.RuleName"> <summary> <para> <para>The name of the receipt rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESReceiptRuleCmdlet.RuleSetName"> <summary> <para> <para>The name of the receipt rule set to which the receipt rule belongs.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESReceiptRuleSetCmdlet"> <summary> Returns the details of the specified receipt rule set. <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESReceiptRuleSetCmdlet.RuleSetName"> <summary> <para> <para>The name of the receipt rule set to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESReceiptRuleSetsCmdlet"> <summary> Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a <code>NextToken</code> that you can provide to the next call to <code>ListReceiptRuleSets</code> to retrieve the additional entries. <para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.GetSESReceiptRuleSetsCmdlet.NextToken"> <summary> <para> <para>A token returned from a previous call to <code>ListReceiptRuleSets</code> to indicate the position in the receipt rule set list.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESSendQuotaCmdlet"> <summary> Returns the user's current sending limits. <para> This action is throttled at one request per second. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESSendStatisticsCmdlet"> <summary> Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity. <para> Each data point in the list contains statistics for a 15-minute interval. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.GetSESVerifiedEmailAddressCmdlet"> <summary> Returns a list containing all of the email addresses that have been verified. <important>The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.</important><para> This action is throttled at one request per second. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptFilterCmdlet"> <summary> Creates a new IP address filter. <para> For information about setting up IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptFilterCmdlet.IpFilter_Cidr"> <summary> <para> <para>A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see <a href="https://tools.ietf.org/html/rfc2317">RFC 2317</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptFilterCmdlet.Filter_Name"> <summary> <para> <para>The name of the IP address filter. The name must:</para><ul><li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</li><li>Start and end with a letter or number.</li><li>Contain less than 64 characters.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptFilterCmdlet.IpFilter_Policy"> <summary> <para> <para>Indicates whether to block or allow incoming mail from the specified IP addresses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptFilterCmdlet.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.SES.NewSESReceiptRuleCmdlet"> <summary> Creates a receipt rule. <para> For information about setting up receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.Rule_Action"> <summary> <para> <para>An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.After"> <summary> <para> <para>The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.Rule_Enabled"> <summary> <para> <para>If <code>true</code>, the receipt rule is active. The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.Rule_Name"> <summary> <para> <para>The name of the receipt rule. The name must:</para><ul><li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</li><li>Start and end with a letter or number.</li><li>Contain less than 64 characters.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.Rule_Recipient"> <summary> <para> <para>The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.RuleSetName"> <summary> <para> <para>The name of the rule set to which to add the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.Rule_ScanEnabled"> <summary> <para> <para>If <code>true</code>, then messages to which this receipt rule applies are scanned for spam and viruses. The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.Rule_TlsPolicy"> <summary> <para> <para>Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The default is <code>Optional</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleCmdlet.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.SES.NewSESReceiptRuleSetCmdlet"> <summary> Creates an empty receipt rule set. <para> For information about setting up receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleSetCmdlet.RuleSetName"> <summary> <para> <para>The name of the rule set to create. The name must:</para><ul><li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</li><li>Start and end with a letter or number.</li><li>Contain less than 64 characters.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleSetCmdlet.PassThru"> <summary> Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.NewSESReceiptRuleSetCmdlet.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.SES.RemoveSESIdentityCmdlet"> <summary> Deletes the specified identity (email address or domain) from the list of verified identities. <para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESIdentityCmdlet.Identity"> <summary> <para> <para>The identity to be removed from the list of identities for the AWS Account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESIdentityCmdlet.PassThru"> <summary> Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESIdentityCmdlet.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.SES.RemoveSESIdentityPolicyCmdlet"> <summary> Deletes the specified sending authorization policy for the given identity (email address or domain). This API returns successfully even if a policy with the specified name does not exist. <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note><para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESIdentityPolicyCmdlet.Identity"> <summary> <para> <para>The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</para><para>To successfully call this API, you must own the identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESIdentityPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESIdentityPolicyCmdlet.PassThru"> <summary> Returns the value passed to the PolicyName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESIdentityPolicyCmdlet.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.SES.RemoveSESReceiptFilterCmdlet"> <summary> Deletes the specified IP address filter. <para> For information about managing IP address filters, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptFilterCmdlet.FilterName"> <summary> <para> <para>The name of the IP address filter to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptFilterCmdlet.PassThru"> <summary> Returns the value passed to the FilterName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptFilterCmdlet.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.SES.RemoveSESReceiptRuleCmdlet"> <summary> Deletes the specified receipt rule. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptRuleCmdlet.RuleName"> <summary> <para> <para>The name of the receipt rule to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptRuleCmdlet.RuleSetName"> <summary> <para> <para>The name of the receipt rule set that contains the receipt rule to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptRuleCmdlet.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.SES.RemoveSESReceiptRuleSetCmdlet"> <summary> Deletes the specified receipt rule set and all of the receipt rules it contains. <note>The currently active rule set cannot be deleted.</note><para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptRuleSetCmdlet.RuleSetName"> <summary> <para> <para>The name of the receipt rule set to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptRuleSetCmdlet.PassThru"> <summary> Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESReceiptRuleSetCmdlet.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.SES.RemoveSESVerifiedEmailAddressCmdlet"> <summary> Deletes the specified email address from the list of verified addresses. <important>The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.</important><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESVerifiedEmailAddressCmdlet.EmailAddress"> <summary> <para> <para>An email address to be removed from the list of verified addresses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESVerifiedEmailAddressCmdlet.PassThru"> <summary> Returns the value passed to the EmailAddress parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.RemoveSESVerifiedEmailAddressCmdlet.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.SES.SendSESBounceCmdlet"> <summary> Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it. <note>You cannot use this API to send generic bounces for mail that was not received by Amazon SES.</note><para> For information about receiving email through Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.MessageDsn_ArrivalDate"> <summary> <para> <para>When the message was received by the reporting mail transfer agent (MTA), in <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a> date-time format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.BouncedRecipientInfoList"> <summary> <para> <para>A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one <code>BouncedRecipientInfo</code> in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.BounceSender"> <summary> <para> <para>The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.BounceSenderArn"> <summary> <para> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.Explanation"> <summary> <para> <para>Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.MessageDsn_ExtensionField"> <summary> <para> <para>Additional X-headers to include in the DSN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.OriginalMessageId"> <summary> <para> <para>The message ID of the message to be bounced.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.MessageDsn_ReportingMta"> <summary> <para> <para>The reporting MTA that attempted to deliver the message, formatted as specified in <a href="https://tools.ietf.org/html/rfc3464">RFC 3464</a> (<code>mta-name-type; mta-name</code>). The default value is <code>dns; inbound-smtp.[region].amazonaws.com</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESBounceCmdlet.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.SES.SendSESEmailCmdlet"> <summary> Composes an email message based on input data, and then immediately queues the message for sending. <para> There are several important points to know about <code>SendEmail</code>: </para><ul><li>You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>.</li><li>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</li><li>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</li><li>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Amazon SES Developer Guide</a>.</li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Destination_BccAddress"> <summary> <para> <para>The BCC: field(s) of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Destination_CcAddress"> <summary> <para> <para>The CC: field(s) of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Html_Charset"> <summary> <para> <para>The character set of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Text_Charset"> <summary> <para> <para>The character set of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Subject_Charset"> <summary> <para> <para>The character set of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Html_Data"> <summary> <para> <para>The textual data of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Text_Data"> <summary> <para> <para>The textual data of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Subject_Data"> <summary> <para> <para>The textual data of the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.ReplyToAddress"> <summary> <para> <para>The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.ReturnPath"> <summary> <para> <para>The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.ReturnPathArn"> <summary> <para> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter.</para><para>For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>.</para><para>For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Source"> <summary> <para> <para>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>.</para><para>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</para><para> In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="http://tools.ietf.org/html/rfc2047">RFC 2047</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.SourceArn"> <summary> <para> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter.</para><para>For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>.</para><para>For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.Destination_ToAddress"> <summary> <para> <para>The To: field(s) of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESEmailCmdlet.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.SES.SendSESRawEmailCmdlet"> <summary> Sends an email message, with header and content specified by the client. The <code>SendRawEmail</code> action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent. <para> There are several important points to know about <code>SendRawEmail</code>: </para><ul><li>You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html">Amazon SES Developer Guide</a>.</li><li>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</li><li>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</li><li>The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.</li><li>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html">Amazon SES Developer Guide</a>.</li><li>If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>, and/or <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw email: <ul><li><code>X-SES-SOURCE-ARN</code></li><li><code>X-SES-FROM-ARN</code></li><li><code>X-SES-RETURN-PATH-ARN</code></li></ul><important>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</important> For the most common sending authorization use case, we recommend that you specify the <code>SourceIdentityArn</code> and do not specify either the <code>FromIdentityArn</code> or <code>ReturnPathIdentityArn</code>. (The same note applies to the corresponding X-headers.) If you only specify the <code>SourceIdentityArn</code>, Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESRawEmailCmdlet.RawMessage_Data"> <summary> <para> <para>The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary). </para><para>The To:, CC:, and BCC: headers in the raw message can contain a group list. </para><para>If you are using <code>SendRawEmail</code> with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for <code>SendRawEmail</code>. </para><important>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</important><para>For more information, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html">Amazon SES Developer Guide</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESRawEmailCmdlet.Destination"> <summary> <para> <para>A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESRawEmailCmdlet.FromArn"> <summary> <para> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular "From" address in the header of the raw email.</para><para>Instead of using this parameter, you can use the X-header <code>X-SES-FROM-ARN</code> in the raw message of the email. If you use both the <code>FromArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>FromArn</code> parameter.</para><note>For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESRawEmailCmdlet.ReturnPathArn"> <summary> <para> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter.</para><para>For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>.</para><para>Instead of using this parameter, you can use the X-header <code>X-SES-RETURN-PATH-ARN</code> in the raw message of the email. If you use both the <code>ReturnPathArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>ReturnPathArn</code> parameter.</para><note>For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESRawEmailCmdlet.Source"> <summary> <para> <para>The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)</para><para> By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href="http://tools.ietf.org/html/rfc2047">RFC 2047</a>. </para><note>If you specify the <code>Source</code> parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any <i>Return-Path</i> header that you might include in the raw text of the message. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESRawEmailCmdlet.SourceArn"> <summary> <para> <para>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter.</para><para>For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>.</para><para>Instead of using this parameter, you can use the X-header <code>X-SES-SOURCE-ARN</code> in the raw message of the email. If you use both the <code>SourceArn</code> parameter and the corresponding X-header, Amazon SES uses the value of the <code>SourceArn</code> parameter.</para><note>For information about when to use this parameter, see the description of <code>SendRawEmail</code> in this guide, or see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html">Amazon SES Developer Guide</a>. </note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SendSESRawEmailCmdlet.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.SES.SetSESActiveReceiptRuleSetCmdlet"> <summary> Sets the specified receipt rule set as the active receipt rule set. <note>To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.</note><para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESActiveReceiptRuleSetCmdlet.RuleSetName"> <summary> <para> <para>The name of the receipt rule set to make active. Setting this value to null disables all email receiving.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESActiveReceiptRuleSetCmdlet.PassThru"> <summary> Returns the value passed to the RuleSetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESActiveReceiptRuleSetCmdlet.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.SES.SetSESIdentityDkimEnabledCmdlet"> <summary> Enables or disables Easy DKIM signing of email sent from an identity: <ul><li>If Easy DKIM signing is enabled for a domain name identity (e.g., <code>example.com</code>), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., <code>user@example.com</code>).</li><li>If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.</li></ul><para> For email addresses (e.g., <code>user@example.com</code>), you can only enable Easy DKIM signing if the corresponding domain (e.g., <code>example.com</code>) has been set up for Easy DKIM using the AWS Console or the <code>VerifyDomainDkim</code> action. </para><para> This action is throttled at one request per second. </para><para> For more information about Easy DKIM signing, go to the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Amazon SES Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityDkimEnabledCmdlet.DkimEnabled"> <summary> <para> <para>Sets whether DKIM signing is enabled for an identity. Set to <code>true</code> to enable DKIM signing for this identity; <code>false</code> to disable it. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityDkimEnabledCmdlet.Identity"> <summary> <para> <para>The identity for which DKIM signing should be enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityDkimEnabledCmdlet.PassThru"> <summary> Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityDkimEnabledCmdlet.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.SES.SetSESIdentityFeedbackForwardingEnabledCmdlet"> <summary> Given an identity (email address or domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints. <note>Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.</note><para> This action is throttled at one request per second. </para><para> For more information about using notifications with Amazon SES, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityFeedbackForwardingEnabledCmdlet.ForwardingEnabled"> <summary> <para> <para>Sets whether Amazon SES will forward bounce and complaint notifications as email. <code>true</code> specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. <code>false</code> specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to <code>false</code> when Amazon SNS topics are set for both <code>Bounce</code> and <code>Complaint</code> notification types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityFeedbackForwardingEnabledCmdlet.Identity"> <summary> <para> <para>The identity for which to set bounce and complaint notification forwarding. Examples: <code>user@example.com</code>, <code>example.com</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityFeedbackForwardingEnabledCmdlet.PassThru"> <summary> Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityFeedbackForwardingEnabledCmdlet.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.SES.SetSESIdentityNotificationTopicCmdlet"> <summary> Given an identity (email address or domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the <code>Source</code>. <note>Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see <code>SetIdentityFeedbackForwardingEnabled</code>. </note><para> This action is throttled at one request per second. </para><para> For more information about feedback notification, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html">Amazon SES Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityNotificationTopicCmdlet.Identity"> <summary> <para> <para>The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityNotificationTopicCmdlet.NotificationType"> <summary> <para> <para>The type of notifications that will be published to the specified Amazon SNS topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityNotificationTopicCmdlet.SnsTopic"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, <code>SnsTopic</code> is cleared and publishing is disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityNotificationTopicCmdlet.PassThru"> <summary> Returns the value passed to the Identity parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESIdentityNotificationTopicCmdlet.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.SES.SetSESReceiptRulePositionCmdlet"> <summary> Sets the position of the specified receipt rule in the receipt rule set. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESReceiptRulePositionCmdlet.After"> <summary> <para> <para>The name of the receipt rule after which to place the specified receipt rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESReceiptRulePositionCmdlet.RuleName"> <summary> <para> <para>The name of the receipt rule to reposition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESReceiptRulePositionCmdlet.RuleSetName"> <summary> <para> <para>The name of the receipt rule set that contains the receipt rule to reposition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESReceiptRulePositionCmdlet.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.SES.SetSESReceiptRuleSetOrderCmdlet"> <summary> Reorders the receipt rules within a receipt rule set. <note>All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn’t explicitly position all of the rules.</note><para> For information about managing receipt rule sets, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESReceiptRuleSetOrderCmdlet.RuleName"> <summary> <para> <para>A list of the specified receipt rule set's receipt rules in the order that you want to put them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESReceiptRuleSetOrderCmdlet.RuleSetName"> <summary> <para> <para>The name of the receipt rule set to reorder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESReceiptRuleSetOrderCmdlet.PassThru"> <summary> Returns the value passed to the RuleName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.SetSESReceiptRuleSetOrderCmdlet.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.SES.UpdateSESReceiptRuleCmdlet"> <summary> Updates a receipt rule. <para> For information about managing receipt rules, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.UpdateSESReceiptRuleCmdlet.Rule_Action"> <summary> <para> <para>An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.UpdateSESReceiptRuleCmdlet.Rule_Enabled"> <summary> <para> <para>If <code>true</code>, the receipt rule is active. The default value is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.UpdateSESReceiptRuleCmdlet.Rule_Name"> <summary> <para> <para>The name of the receipt rule. The name must:</para><ul><li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</li><li>Start and end with a letter or number.</li><li>Contain less than 64 characters.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.UpdateSESReceiptRuleCmdlet.Rule_Recipient"> <summary> <para> <para>The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.UpdateSESReceiptRuleCmdlet.RuleSetName"> <summary> <para> <para>The name of the receipt rule set to which the receipt rule belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.UpdateSESReceiptRuleCmdlet.Rule_ScanEnabled"> <summary> <para> <para>If <code>true</code>, then messages to which this receipt rule applies are scanned for spam and viruses. The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.UpdateSESReceiptRuleCmdlet.Rule_TlsPolicy"> <summary> <para> <para>Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The default is <code>Optional</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.UpdateSESReceiptRuleCmdlet.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.SES.WriteSESIdentityPolicyCmdlet"> <summary> Adds or updates a sending authorization policy for the specified identity (email address or domain). <note>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</note><para> Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>. </para><para> This action is throttled at one request per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.WriteSESIdentityPolicyCmdlet.Identity"> <summary> <para> <para>The identity to which the policy will apply. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</para><para>To successfully call this API, you must own the identity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.WriteSESIdentityPolicyCmdlet.Policy"> <summary> <para> <para>The text of the policy in JSON format. The policy cannot exceed 4 KB.</para><para>For information about the syntax of sending authorization policies, see the <a href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html">Amazon SES Developer Guide</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.WriteSESIdentityPolicyCmdlet.PolicyName"> <summary> <para> <para>The name of the policy.</para><para>The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.WriteSESIdentityPolicyCmdlet.PassThru"> <summary> Returns the value passed to the Policy parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SES.WriteSESIdentityPolicyCmdlet.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.SNS.AddSNSPermissionCmdlet"> <summary> Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.ActionName"> <summary> <para> <para>The action you want to allow for the specified principal(s).</para><para>Valid values: any Amazon SNS action name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.AWSAccountId"> <summary> <para> <para>The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.Label"> <summary> <para> <para>A unique identifier for the new policy statement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic whose access control policy you wish to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.PassThru"> <summary> Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.AddSNSPermissionCmdlet.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.SNS.ConfirmSNSSubscriptionCmdlet"> <summary> Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to "true". </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.AuthenticateOnUnsubscribe"> <summary> <para> <para>Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code> and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.Token"> <summary> <para> <para>Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic for which you wish to confirm a subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConfirmSNSSubscriptionCmdlet.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.SNS.ConnectSNSNotificationCmdlet"> <summary> Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three days. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.Endpoint"> <summary> <para> <para>The endpoint that you want to receive notifications. Endpoints vary by protocol:</para><ul><li>For the <code>http</code> protocol, the endpoint is an URL beginning with "http://"</li><li>For the <code>https</code> protocol, the endpoint is a URL beginning with "https://"</li><li>For the <code>email</code> protocol, the endpoint is an email address</li><li>For the <code>email-json</code> protocol, the endpoint is an email address</li><li>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device</li><li>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue</li><li>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.Protocol"> <summary> <para> <para>The protocol you want to use. Supported protocols include:</para><ul><li><code>http</code> -- delivery of JSON-encoded message via HTTP POST</li><li><code>https</code> -- delivery of JSON-encoded message via HTTPS POST</li><li><code>email</code> -- delivery of message via SMTP</li><li><code>email-json</code> -- delivery of JSON-encoded message via SMTP</li><li><code>sms</code> -- delivery of message via SMS</li><li><code>sqs</code> -- delivery of JSON-encoded message to an Amazon SQS queue</li><li><code>application</code> -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic you want to subscribe to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.ConnectSNSNotificationCmdlet.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.SNS.DisconnectSNSNotificationCmdlet"> <summary> Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the <code>Unsubscribe</code> call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the <code>Unsubscribe</code> request was unintended. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.DisconnectSNSNotificationCmdlet.SubscriptionArn"> <summary> <para> <para>The ARN of the subscription to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.DisconnectSNSNotificationCmdlet.PassThru"> <summary> Returns the value passed to the SubscriptionArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.DisconnectSNSNotificationCmdlet.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.SNS.GetSNSEndpointAttributesCmdlet"> <summary> Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointAttributesCmdlet.EndpointArn"> <summary> <para> <para>EndpointArn for GetEndpointAttributes input.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet"> <summary> Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListEndpointsByPlatformApplication</code> again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSEndpointsByPlatformApplicationCmdlet.NextToken"> <summary> <para> <para>NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationAttributesCmdlet"> <summary> Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationAttributesCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn for GetPlatformApplicationAttributesInput.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationsCmdlet"> <summary> Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSPlatformApplicationsCmdlet.NextToken"> <summary> <para> <para>NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionCmdlet"> <summary> Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptions</code> call to get further results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionCmdlet.NextToken"> <summary> <para> <para>Token returned by the previous <code>ListSubscriptions</code> request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionAttributeCmdlet"> <summary> Returns all of the properties of a subscription. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionAttributeCmdlet.SubscriptionArn"> <summary> <para> <para>The ARN of the subscription whose properties you want to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet"> <summary> Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic for which you wish to find subscriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSSubscriptionByTopicCmdlet.NextToken"> <summary> <para> <para>Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicCmdlet"> <summary> Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get further results. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicCmdlet.NextToken"> <summary> <para> <para>Token returned by the previous <code>ListTopics</code> request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicAttributeCmdlet"> <summary> Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.GetSNSTopicAttributeCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic whose properties you want to get.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet"> <summary> Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the <code>CreatePlatformApplication</code> action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when using <code>CreatePlatformApplication</code> is then used as an attribute for the <code>CreatePlatformEndpoint</code> action. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.Attribute"> <summary> <para> <para>For a list of attributes, see <a href="http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html">SetPlatformApplicationAttributes</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.Name"> <summary> <para> <para>Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.Platform"> <summary> <para> <para>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformApplicationCmdlet.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.SNS.NewSNSPlatformEndpointCmdlet"> <summary> Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. <code>CreatePlatformEndpoint</code> requires the PlatformApplicationArn that is returned from <code>CreatePlatformApplication</code>. The EndpointArn that is returned when using <code>CreatePlatformEndpoint</code> can then be used by the <code>Publish</code> action to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. <para> When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html">Creating an Amazon SNS Endpoint for Baidu</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.Attribute"> <summary> <para> <para>For a list of attributes, see <a href="http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html">SetEndpointAttributes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.CustomUserData"> <summary> <para> <para>Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.Token"> <summary> <para> <para>Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSPlatformEndpointCmdlet.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.SNS.NewSNSTopicCmdlet"> <summary> Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see <a href="http://aws.amazon.com/sns/">http://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.Name"> <summary> <para> <para>The name of the topic you want to create.</para><para>Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.NewSNSTopicCmdlet.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.SNS.PublishSNSMessageCmdlet"> <summary> Sends a message to all of a topic's subscribed endpoints. When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected. <para> To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. The second example below shows a request and response for publishing to a mobile endpoint. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.Message"> <summary> <para> <para>The message you want to send to the topic.</para><para>If you want to send the same message to all transport protocols, include the text of the message as a String value.</para><para>If you want to send different messages for each transport protocol, set the value of the <code>MessageStructure</code> parameter to <code>json</code> and use a JSON object for the <code>Message</code> parameter. See the Examples section for the format of the JSON object. </para><para>Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).</para><para>JSON-specific constraints: <ul><li>Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values. </li><li>The values will be parsed (unescaped) before they are used in outgoing messages.</li><li>Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).</li><li>Values have a minimum length of 0 (the empty string, "", is allowed).</li><li>Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).</li><li>Non-string values will cause the key to be ignored.</li><li>Keys that do not correspond to supported transport protocols are ignored.</li><li>Duplicate keys are not allowed.</li><li>Failure to parse or validate any key or value in the message will cause the <code>Publish</code> call to return an error (no partial delivery).</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.MessageAttribute"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.MessageStructure"> <summary> <para> <para>Set <code>MessageStructure</code> to <code>json</code> if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set <code>MessageStructure</code> to <code>json</code>, the value of the <code>Message</code> parameter must: </para><ul><li>be a syntactically valid JSON object; and</li><li>contain at least a top-level JSON key of "default" with a value that is a string.</li></ul><para> You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). </para><para>For information about sending different messages for each protocol using the AWS Management Console, go to <a href="http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol">Create Different Messages for Each Protocol</a> in the <i>Amazon Simple Notification Service Getting Started Guide</i>. </para><para>Valid value: <code>json</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.Subject"> <summary> <para> <para>Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.</para><para>Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.TargetArn"> <summary> <para> <para>Either TopicArn or EndpointArn, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.TopicArn"> <summary> <para> <para>The topic you want to publish to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.PublishSNSMessageCmdlet.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.SNS.RemoveSNSEndpointCmdlet"> <summary> Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet.EndpointArn"> <summary> <para> <para>EndpointArn of endpoint to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet.PassThru"> <summary> Returns the value passed to the EndpointArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSEndpointCmdlet.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.SNS.RemoveSNSPermissionCmdlet"> <summary> Removes a statement from a topic's access control policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.Label"> <summary> <para> <para>The unique label of the statement you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic whose access control policy you wish to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.PassThru"> <summary> Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPermissionCmdlet.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.SNS.RemoveSNSPlatformApplicationCmdlet"> <summary> Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn of platform application object to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet.PassThru"> <summary> Returns the value passed to the PlatformApplicationArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSPlatformApplicationCmdlet.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.SNS.RemoveSNSTopicCmdlet"> <summary> Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSTopicCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSTopicCmdlet.PassThru"> <summary> Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.RemoveSNSTopicCmdlet.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.SNS.SetSNSEndpointAttributesCmdlet"> <summary> Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributesCmdlet.Attribute"> <summary> <para> <para>A map of the endpoint attributes. Attributes in this map include the following:</para><ul><li><code>CustomUserData</code> -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</li><li><code>Enabled</code> -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.</li><li><code>Token</code> -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributesCmdlet.EndpointArn"> <summary> <para> <para>EndpointArn used for SetEndpointAttributes action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributesCmdlet.PassThru"> <summary> Returns the value passed to the EndpointArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSEndpointAttributesCmdlet.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.SNS.SetSNSPlatformApplicationAttributesCmdlet"> <summary> Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributesCmdlet.Attribute"> <summary> <para> <para>A map of the platform application attributes. Attributes in this map include the following:</para><ul><li><code>PlatformCredential</code> -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".</li><li><code>PlatformPrincipal</code> -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id".</li><li><code>EventEndpointCreated</code> -- Topic ARN to which EndpointCreated event notifications should be sent.</li><li><code>EventEndpointDeleted</code> -- Topic ARN to which EndpointDeleted event notifications should be sent.</li><li><code>EventEndpointUpdated</code> -- Topic ARN to which EndpointUpdate event notifications should be sent.</li><li><code>EventDeliveryFailure</code> -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributesCmdlet.PlatformApplicationArn"> <summary> <para> <para>PlatformApplicationArn for SetPlatformApplicationAttributes action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributesCmdlet.PassThru"> <summary> Returns the value passed to the PlatformApplicationArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSPlatformApplicationAttributesCmdlet.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.SNS.SetSNSSubscriptionAttributeCmdlet"> <summary> Allows a subscription owner to set an attribute of the topic to a new value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.AttributeName"> <summary> <para> <para>The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.</para><para>Valid values: <code>DeliveryPolicy</code> | <code>RawMessageDelivery</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.AttributeValue"> <summary> <para> <para>The new value for the attribute in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.SubscriptionArn"> <summary> <para> <para>The ARN of the subscription to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.PassThru"> <summary> Returns the value passed to the SubscriptionArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSSubscriptionAttributeCmdlet.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.SNS.SetSNSTopicAttributeCmdlet"> <summary> Allows a topic owner to set an attribute of the topic to a new value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.AttributeName"> <summary> <para> <para>The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.</para><para>Valid values: <code>Policy</code> | <code>DisplayName</code> | <code>DeliveryPolicy</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.AttributeValue"> <summary> <para> <para>The new value for the attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.TopicArn"> <summary> <para> <para>The ARN of the topic to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.PassThru"> <summary> Returns the value passed to the TopicArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNS.SetSNSTopicAttributeCmdlet.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.SSM.GetSSMAssociationCmdlet"> <summary> Describes the associations for the specified SSM document or instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationListCmdlet"> <summary> Lists the associations for the specified SSM document or instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationListCmdlet.AssociationFilterList"> <summary> <para> <para>One or more filters. Use a filter to return a more specific list of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMAssociationListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet"> <summary> Lists the commands requested by users of the AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.CommandId"> <summary> <para> (Optional) If provided, lists only the specified command. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.Filter"> <summary> <para> (Optional) One or more filters. Use a filter to return a more specific list of results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.InstanceId"> <summary> <para> (Optional) Lists commands issued against this instance ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.MaxResult"> <summary> <para> (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandCmdlet.NextToken"> <summary> <para> (Optional) The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet"> <summary> An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.CommandId"> <summary> <para> (Optional) The invocations for a specific command ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.Detail"> <summary> <para> (Optional) If set this returns the response of the command executions. By default this is set to False. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.Filter"> <summary> <para> (Optional) One or more filters. Use a filter to return a more specific list of results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.InstanceId"> <summary> <para> (Optional) The command execution details for a specific instance ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.MaxResult"> <summary> <para> (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMCommandInvocationCmdlet.NextToken"> <summary> <para> (Optional) The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentCmdlet"> <summary> Gets the contents of the specified SSM document. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentDescriptionCmdlet"> <summary> Describes the specified SSM document. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentDescriptionCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentListCmdlet"> <summary> Describes one or more of your SSM documents. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentListCmdlet.DocumentFilterList"> <summary> <para> <para>One or more filters. Use a filter to return a more specific list of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMDocumentListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of items to return. (You received this token from a previous call.)</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceInformationCmdlet"> <summary> Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceInformationCmdlet.InstanceInformationFilterList"> <summary> <para> One or more filters. Use a filter to return a more specific list of instances. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceInformationCmdlet.MaxResult"> <summary> <para> The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.GetSSMInstanceInformationCmdlet.NextToken"> <summary> <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet"> <summary> Associates the specified SSM document with the specified instance. <para> When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified. </para><para> If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.InstanceId"> <summary> <para> <para>The instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.Parameter"> <summary> <para> The parameters for the document’s runtime configuration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationCmdlet.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.SSM.NewSSMAssociationFromBatchCmdlet"> <summary> Associates the specified SSM document with the specified instances. <para> When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified. </para><para> If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationFromBatchCmdlet.Entry"> <summary> <para> <para>One or more associations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMAssociationFromBatchCmdlet.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.SSM.NewSSMDocumentCmdlet"> <summary> Creates an SSM document. <para> After you create an SSM document, you can use <a>CreateAssociation</a> to associate it with one or more running instances. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.Content"> <summary> <para> <para>A valid JSON string. For more information about the contents of this string, see <a href="http://docs.aws.amazon.com/ssm/latest/APIReference/aws-ssm-document.html">SSM Document</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.Name"> <summary> <para> <para>A name for the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.NewSSMDocumentCmdlet.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.SSM.RemoveSSMAssociationCmdlet"> <summary> Disassociates the specified SSM document from the specified instance. <para> When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.PassThru"> <summary> Returns the value passed to the InstanceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMAssociationCmdlet.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.SSM.RemoveSSMDocumentCmdlet"> <summary> Deletes the SSM document and all instance associations to the document. <para> Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.RemoveSSMDocumentCmdlet.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.SSM.SendSSMCommandCmdlet"> <summary> Executes commands on one or more remote instances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.Comment"> <summary> <para> User-specified information about the command, such as a brief description of what the command should do. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.DocumentName"> <summary> <para> Required. The name of the SSM document to execute. This can be an SSM public document or a custom document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.InstanceId"> <summary> <para> Required. The instance IDs where the command should execute. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.OutputS3BucketName"> <summary> <para> The name of the S3 bucket where command execution responses should be stored. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.OutputS3KeyPrefix"> <summary> <para> The directory structure within the S3 bucket where the responses should be stored. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.Parameter"> <summary> <para> The required and optional parameters specified in the SSM document being executed. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.TimeoutSecond"> <summary> <para> If this time is reached and the command has not already started executing, it will not execute. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.SendSSMCommandCmdlet.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.SSM.StopSSMCommandCmdlet"> <summary> Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMCommandCmdlet.CommandId"> <summary> <para> The ID of the command you want to cancel. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMCommandCmdlet.InstanceId"> <summary> <para> <para>(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.StopSSMCommandCmdlet.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.SSM.UpdateSSMAssociationStatusCmdlet"> <summary> Updates the status of the SSM document associated with the specified instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.AssociationStatus_AdditionalInfo"> <summary> <para> <para>A user-defined string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.AssociationStatus_Date"> <summary> <para> <para>The date when the status changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.InstanceId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.AssociationStatus_Message"> <summary> <para> <para>The reason for the status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.AssociationStatus_Name"> <summary> <para> <para>The status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.Name"> <summary> <para> <para>The name of the SSM document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSM.UpdateSSMAssociationStatusCmdlet.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.SQS.AddSQSPermissionCmdlet"> <summary> Adds a permission to a queue for a specific <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>. This allows for sharing access to the queue. <para> When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para><note><para><code>AddPermission</code> writes an Amazon SQS-generated policy. If you want to write your own policy, use <a>SetQueueAttributes</a> to upload your policy. For more information about writing your own policy, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AccessPolicyLanguage.html">Using The Access Policy Language</a> in the <i>Amazon SQS Developer Guide</i>. </para></note><note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note><para><code>&Attribute.1=this</code></para><para><code>&Attribute.2=that</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.AddSQSPermissionCmdlet.Action"> <summary> <para> <para>The action the client wants to allow for the specified principal. The following are valid values: <code>* | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl</code>. For more information about these actions, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes">Understanding Permissions</a> in the <i>Amazon SQS Developer Guide</i>.</para><para>Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or <code>ChangeMessageVisibility</code> for the <code>ActionName.n</code> also grants permissions for the corresponding batch versions of those actions: <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and <code>ChangeMessageVisibilityBatch</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.AddSQSPermissionCmdlet.AWSAccountId"> <summary> <para> <para>The AWS account number of the <a href="http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a> who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html">Your AWS Identifiers</a> in the <i>Amazon SQS Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.AddSQSPermissionCmdlet.Label"> <summary> <para> <para>The unique identification of the permission you're setting (e.g., <code>AliceSendMessage</code>). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.AddSQSPermissionCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.AddSQSPermissionCmdlet.PassThru"> <summary> Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.AddSQSPermissionCmdlet.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.SQS.ClearSQSQueueCmdlet"> <summary> Deletes the messages in a queue specified by the <b>queue URL</b>. <important>When you use the <code>PurgeQueue</code> API, the deleted messages in the queue cannot be retrieved.</important><para> When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling <code>PurgeQueue</code> will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before <code>PurgeQueue</code> was called may be received, but will be deleted within the next minute. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ClearSQSQueueCmdlet.QueueUrl"> <summary> <para> <para>The queue URL of the queue to delete the messages from when using the <code>PurgeQueue</code> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ClearSQSQueueCmdlet.PassThru"> <summary> Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ClearSQSQueueCmdlet.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.SQS.EditSQSMessageVisibilityCmdlet"> <summary> Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.) <para> For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call <code>ChangeMessageVisiblity</code> with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes. </para><note><para> There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages. </para></note><important>If you attempt to set the <code>VisibilityTimeout</code> to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.</important><important>Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the <code>ChangeMessageVisibility</code> action.</important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.EditSQSMessageVisibilityCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.EditSQSMessageVisibilityCmdlet.ReceiptHandle"> <summary> <para> <para>The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the <a>ReceiveMessage</a> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.EditSQSMessageVisibilityCmdlet.VisibilityTimeout"> <summary> <para> <para>The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.EditSQSMessageVisibilityCmdlet.PassThru"> <summary> Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.EditSQSMessageVisibilityCmdlet.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.SQS.EditSQSMessageVisibilityBatchCmdlet"> <summary> Changes the visibility timeout of multiple messages. This is a batch version of <a>ChangeMessageVisibility</a>. The result of the action on each message is reported individually in the response. You can send up to 10 <a>ChangeMessageVisibility</a> requests with each <code>ChangeMessageVisibilityBatch</code> action. <important>Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</important><note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note><para><code>&Attribute.1=this</code></para><para><code>&Attribute.2=that</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.EditSQSMessageVisibilityBatchCmdlet.Entry"> <summary> <para> <para>A list of receipt handles of the messages for which the visibility timeout must be changed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.EditSQSMessageVisibilityBatchCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.EditSQSMessageVisibilityBatchCmdlet.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.SQS.GetSQSDeadLetterSourceQueuesCmdlet"> <summary> Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue. <para> For more information about using dead letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.GetSQSDeadLetterSourceQueuesCmdlet.QueueUrl"> <summary> <para> The queue URL of a dead letter queue. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQS.GetSQSQueueCmdlet"> <summary> Returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional <code>QueueNamePrefix</code> parameter, only queues with a name beginning with the specified value are returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.GetSQSQueueCmdlet.QueueNamePrefix"> <summary> <para> <para>A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQS.GetSQSQueueAttributeCmdlet"> <summary> Gets attributes for the specified queue. The following attributes are supported: <ul><li><code>All</code> - returns all values.</li><li><code>ApproximateNumberOfMessages</code> - returns the approximate number of visible messages in a queue. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li><li><code>ApproximateNumberOfMessagesNotVisible</code> - returns the approximate number of messages that are not timed-out and not deleted. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html">Resources Required to Process Messages</a> in the <i>Amazon SQS Developer Guide</i>.</li><li><code>VisibilityTimeout</code> - returns the visibility timeout for the queue. For more information about visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</li><li><code>CreatedTimestamp</code> - returns the time when the queue was created (epoch time in seconds).</li><li><code>LastModifiedTimestamp</code> - returns the time when the queue was last changed (epoch time in seconds).</li><li><code>Policy</code> - returns the queue's policy.</li><li><code>MaximumMessageSize</code> - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.</li><li><code>MessageRetentionPeriod</code> - returns the number of seconds Amazon SQS retains a message.</li><li><code>QueueArn</code> - returns the queue's Amazon resource name (ARN).</li><li><code>ApproximateNumberOfMessagesDelayed</code> - returns the approximate number of messages that are pending to be added to the queue.</li><li><code>DelaySeconds</code> - returns the default delay on the queue in seconds.</li><li><code>ReceiveMessageWaitTimeSeconds</code> - returns the time for which a ReceiveMessage call will wait for a message to arrive.</li><li><code>RedrivePolicy</code> - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html">Using Amazon SQS Dead Letter Queues</a> in the <i>Amazon SQS Developer Guide</i>.</li></ul><note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note><note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note><para><code>&Attribute.1=this</code></para><para><code>&Attribute.2=that</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.GetSQSQueueAttributeCmdlet.AttributeName"> <summary> <para> <para>A list of attributes to retrieve information for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.GetSQSQueueAttributeCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQS.GetSQSQueueUrlCmdlet"> <summary> Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue. <para> To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see <a>AddPermission</a> or go to <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html">Shared Queues</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.GetSQSQueueUrlCmdlet.QueueName"> <summary> <para> <para>The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.GetSQSQueueUrlCmdlet.QueueOwnerAWSAccountId"> <summary> <para> <para>The AWS account ID of the account that created the queue.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SQS.NewSQSQueueCmdlet"> <summary> Creates a new queue, or returns the URL of an existing one. When you request <code>CreateQueue</code>, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. <note><para> If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para></note><para> You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using <a>SetQueueAttributes</a>. </para><note><para> Use <a>GetQueueUrl</a> to get a queue's URL. <a>GetQueueUrl</a> requires only the <code>QueueName</code> parameter. </para></note><para> If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, <code>CreateQueue</code> returns an error. </para><note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note><para><code>&Attribute.1=this</code></para><para><code>&Attribute.2=that</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.NewSQSQueueCmdlet.Attribute"> <summary> <para> <para>A map of attributes with their corresponding values.</para><para>The following lists the names, descriptions, and values of the special request parameters the <code>CreateQueue</code> action uses:</para><para><ul><li><code>DelaySeconds</code> - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).</li><li><code>MaximumMessageSize</code> - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).</li><li><code>MessageRetentionPeriod</code> - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).</li><li><code>Policy</code> - The queue's policy. A valid AWS policy. For more information about policy structure, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>.</li><li><code>ReceiveMessageWaitTimeSeconds</code> - The time for which a <a>ReceiveMessage</a> call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. </li><li><code>VisibilityTimeout</code> - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.NewSQSQueueCmdlet.QueueName"> <summary> <para> <para>The name for the queue to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.NewSQSQueueCmdlet.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.SQS.ReceiveSQSMessageCmdlet"> <summary> Retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the <code>WaitTimeSeconds</code> parameter. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Poll</a> in the <i>Amazon SQS Developer Guide</i>. <para> Short poll is the default behavior where a weighted random set of machines is sampled on a <code>ReceiveMessage</code> call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per <code>ReceiveMessage</code> call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular <code>ReceiveMessage</code> response; in which case you should repeat the request. </para><para> For each message returned, the response includes the following: </para><ul><li><para> Message body </para></li><li><para> MD5 digest of the message body. For information about MD5, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. </para></li><li><para> Message ID you received when you sent the message to the queue. </para></li><li><para> Receipt handle. </para></li><li><para> Message attributes. </para></li><li><para> MD5 digest of the message attributes. </para></li></ul><para> The receipt handle is the identifier you must provide when deleting the message. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html">Queue and Message Identifiers</a> in the <i>Amazon SQS Developer Guide</i>. </para><para> You can provide the <code>VisibilityTimeout</code> parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>. </para><note><para> Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ReceiveSQSMessageCmdlet.AttributeName"> <summary> <para> <para>A list of attributes that need to be returned along with each message. </para><para> The following lists the names and descriptions of the attributes that can be returned: </para><ul><li><code>All</code> - returns all values.</li><li><code>ApproximateFirstReceiveTimestamp</code> - returns the time when the message was first received from the queue (epoch time in milliseconds).</li><li><code>ApproximateReceiveCount</code> - returns the number of times a message has been received from the queue but not deleted.</li><li><code>SenderId</code> - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.</li><li><code>SentTimestamp</code> - returns the time when the message was sent to the queue (epoch time in milliseconds).</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ReceiveSQSMessageCmdlet.MessageCount"> <summary> <para> <para>The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.</para><para>All of the messages are not necessarily returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ReceiveSQSMessageCmdlet.MessageAttributeName"> <summary> <para> <para>The name of the message attribute, where <i>N</i> is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.</para><para>When using <code>ReceiveMessage</code>, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "foo.*" to return all message attributes starting with the "foo" prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ReceiveSQSMessageCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ReceiveSQSMessageCmdlet.VisibilityTimeout"> <summary> <para> <para>The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a <code>ReceiveMessage</code> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ReceiveSQSMessageCmdlet.WaitTimeInSeconds"> <summary> <para> <para>The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.ReceiveSQSMessageCmdlet.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.SQS.RemoveSQSMessageCmdlet"> <summary> Deletes the specified message from the specified queue. You specify the message by using the message's <code>receipt handle</code> and not the <code>message ID</code> you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it. <note><para> The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request <code>DeleteMessage</code>, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted. </para></note><important><para> It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSMessageCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSMessageCmdlet.ReceiptHandle"> <summary> <para> <para>The receipt handle associated with the message to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSMessageCmdlet.PassThru"> <summary> Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSMessageCmdlet.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.SQS.RemoveSQSMessageBatchCmdlet"> <summary> Deletes up to ten messages from the specified queue. This is a batch version of <a>DeleteMessage</a>. The result of the delete action on each message is reported individually in the response. <important><para> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </para></important><note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note><para><code>&Attribute.1=this</code></para><para><code>&Attribute.2=that</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSMessageBatchCmdlet.Entry"> <summary> <para> <para>A list of receipt handles for the messages to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSMessageBatchCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSMessageBatchCmdlet.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.SQS.RemoveSQSPermissionCmdlet"> <summary> Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter. Only the owner of the queue can remove permissions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSPermissionCmdlet.Label"> <summary> <para> <para>The identification of the permission to remove. This is the label added with the <a>AddPermission</a> action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSPermissionCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSPermissionCmdlet.PassThru"> <summary> Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSPermissionCmdlet.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.SQS.RemoveSQSQueueCmdlet"> <summary> Deletes the queue specified by the <b>queue URL</b>, regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response. <important><para> Use <code>DeleteQueue</code> with care; once you delete your queue, any messages in the queue are no longer available. </para></important><para> When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a <a>SendMessage</a> request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </para><para> We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSConcepts.html">How Amazon SQS Queues Work</a> in the <i>Amazon SQS Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSQueueCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSQueueCmdlet.PassThru"> <summary> Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.RemoveSQSQueueCmdlet.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.SQS.SendSQSMessageCmdlet"> <summary> Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes. <important><para> The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a> If you send any characters not included in the list, your request will be rejected. </para><para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SendSQSMessageCmdlet.DelayInSeconds"> <summary> <para> <para> The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive <code>DelaySeconds</code> value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SendSQSMessageCmdlet.MessageAttribute"> <summary> <para> <para>Each message attribute consists of a Name, Type, and Value. For more information, see <a href="http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV">Message Attribute Items</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SendSQSMessageCmdlet.MessageBody"> <summary> <para> <para>The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SendSQSMessageCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SendSQSMessageCmdlet.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.SQS.SendSQSMessageBatchCmdlet"> <summary> Delivers up to ten messages to the specified queue. This is a batch version of <a>SendMessage</a>. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes). <para> The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes). </para><para> If the <code>DelaySeconds</code> parameter is not specified for an entry, the default for the queue is used. </para><important>The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to <a href="http://www.faqs.org/rfcs/rfc1321.html">http://www.faqs.org/rfcs/rfc1321.html</a>. If you send any characters that are not included in the list, your request will be rejected. <para> #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] </para></important><important> Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200. </important><note>Some API actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this: </note><para><code>&Attribute.1=this</code></para><para><code>&Attribute.2=that</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SendSQSMessageBatchCmdlet.Entry"> <summary> <para> <para>A list of <a>SendMessageBatchRequestEntry</a> items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SendSQSMessageBatchCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SendSQSMessageBatchCmdlet.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.SQS.SetSQSQueueAttributeCmdlet"> <summary> Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes. <note>Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SetSQSQueueAttributeCmdlet.Attribute"> <summary> <para> <para>A map of attributes to set.</para><para>The following lists the names, descriptions, and values of the special request parameters the <code>SetQueueAttributes</code> action uses:</para><para><ul><li><code>DelaySeconds</code> - The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).</li><li><code>MaximumMessageSize</code> - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).</li><li><code>MessageRetentionPeriod</code> - The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).</li><li><code>Policy</code> - The queue's policy. A valid AWS policy. For more information about policy structure, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html">Overview of AWS IAM Policies</a> in the <i>Amazon IAM User Guide</i>.</li><li><code>ReceiveMessageWaitTimeSeconds</code> - The time for which a ReceiveMessage call will wait for a message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0. </li><li><code>VisibilityTimeout</code> - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the <i>Amazon SQS Developer Guide</i>.</li><li><code>RedrivePolicy</code> - The parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the <i>Amazon SQS Developer Guide</i>.</li></ul></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SetSQSQueueAttributeCmdlet.QueueUrl"> <summary> <para> <para>The URL of the Amazon SQS queue to take action on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SetSQSQueueAttributeCmdlet.PassThru"> <summary> Returns the value passed to the QueueUrl parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SQS.SetSQSQueueAttributeCmdlet.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.SG.AddSGCacheCmdlet"> <summary> This operation configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html">Storage Gateway Concepts</a>). <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGCacheCmdlet.DiskId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGCacheCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGCacheCmdlet.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.SG.AddSGResourceTagCmdlet"> <summary> This operation adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources: <ul><li><para> Storage gateways of all types </para></li></ul><ul><li><para> Storage Volumes </para></li></ul><ul><li><para> Virtual Tapes </para></li></ul><para> You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource you want to add tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGResourceTagCmdlet.Tag"> <summary> <para> <para>The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.</para><note><para>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGResourceTagCmdlet.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.SG.AddSGUploadBufferCmdlet"> <summary> This operation configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures. <para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGUploadBufferCmdlet.DiskId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGUploadBufferCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGUploadBufferCmdlet.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.SG.AddSGWorkingStorageCmdlet"> <summary> This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated method in cached-volumes API version (20120630). Use AddUploadBuffer instead. <note><para> Working storage is also referred to as upload buffer. You can also use the <a>AddUploadBuffer</a> operation to add upload buffer to a stored-volume gateway. </para></note><para> In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGWorkingStorageCmdlet.DiskId"> <summary> <para> <para>An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the <a>ListLocalDisks</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGWorkingStorageCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.AddSGWorkingStorageCmdlet.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.SG.DisableSGGatewayCmdlet"> <summary> Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes. <para> Use this operation for a gateway-VTL that is not reachable or not functioning. </para><important>Once a gateway is disabled it cannot be enabled.</important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.DisableSGGatewayCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.DisableSGGatewayCmdlet.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.SG.EnableSGGatewayCmdlet"> <summary> This operation activates the gateway you previously deployed on your host. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedActivateGateway-common.html"> Activate the AWS Storage Gateway</a>. In the activation process, you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see <a>UpdateGatewayInformation</a>. <note>You must turn on the gateway VM before you can activate your gateway.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.ActivationKey"> <summary> <para> <para>Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter <code>activationKey</code>. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the <code>ActivateGateway</code> API call determine the actual configuration of your gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.GatewayName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.GatewayRegion"> <summary> <para> <para>One of the values that indicates the region where you want to store the snapshot backups. The gateway region specified must be the same region as the region in your <code>Host</code> header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</para><para><i>Valid Values</i>: "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.GatewayTimezone"> <summary> <para> <para>One of the values that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.GatewayType"> <summary> <para> <para>One of the values that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is <code>STORED</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.MediumChangerType"> <summary> <para> <para>The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.</para><para><i>Valid Values</i>: "STK-L700", "AWS-Gateway-VTL"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.TapeDriveType"> <summary> <para> <para>The value that indicates the type of tape drive to use for gateway-VTL. This field is optional. </para><para><i>Valid Values</i>: "IBM-ULT3580-TD5" </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.EnableSGGatewayCmdlet.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.SG.GetSGBandwidthRateLimitCmdlet"> <summary> This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. <para> This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGBandwidthRateLimitCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGCacheCmdlet"> <summary> This operation returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture. <para> The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGCacheCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGCachediSCSIVolumeCmdlet"> <summary> This operation returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture. <para> The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGCachediSCSIVolumeCmdlet.VolumeARNs"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGChapCredentialsCmdlet"> <summary> This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGChapCredentialsCmdlet.TargetARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayCmdlet"> <summary> This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN). <para> By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response. </para><para> If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayCmdlet.Limit"> <summary> <para> <para>Specifies that the list of gateways returned be limited to the specified number of items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin the returned list of gateways.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayInformationCmdlet"> <summary> This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGGatewayInformationCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGLocalDiskCmdlet"> <summary> This operation returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request. <para> The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a <code>DiskStatus</code> field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGLocalDiskCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGMaintenanceStartTimeCmdlet"> <summary> This operation returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGMaintenanceStartTimeCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGResourceTagsCmdlet"> <summary> This operation lists the tags that have been added to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGResourceTagsCmdlet.Limit"> <summary> <para> <para>Specifies that the list of tags returned be limited to the specified number of items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGResourceTagsCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin returning the list of tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGResourceTagsCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which you want to list tags.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGSnapshotScheduleCmdlet"> <summary> This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGSnapshotScheduleCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGStorediSCSIVolumeCmdlet"> <summary> This operation returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGStorediSCSIVolumeCmdlet.VolumeARNs"> <summary> <para> <para>An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a gateway.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveCmdlet"> <summary> Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS. <para> Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveCmdlet.GatewayARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</para><para>You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchiveCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS). </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchivesCmdlet"> <summary> Returns a description of specified virtual tapes in the virtual tape shelf (VTS). <para> If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchivesCmdlet.TapeARNs"> <summary> <para> <para>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchivesCmdlet.Limit"> <summary> <para> <para>Specifies that the number of virtual tapes descried be limited to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeArchivesCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin describing virtual tapes.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointCmdlet"> <summary> Retrieves the recovery point for the specified virtual tape. <para> A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. </para><note>The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointsCmdlet"> <summary> Returns a list of virtual tape recovery points that are available for the specified gateway-VTL. <para> A recovery point is a point in time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointsCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointsCmdlet.Limit"> <summary> <para> <para>Specifies that the number of virtual tape recovery points that are described be limited to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapeRecoveryPointsCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin describing the virtual tape recovery points.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGTapesCmdlet"> <summary> Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all virtual tapes associated with the specified gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapesCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapesCmdlet.TapeARNs"> <summary> <para> <para>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapesCmdlet.Limit"> <summary> <para> <para>Specifies that the number of virtual tapes described be limited to the specified number.</para><note>Amazon Web Services may impose its own limit, if this field is not set.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGTapesCmdlet.Marker"> <summary> <para> <para>A marker value, obtained in a previous call to <code>DescribeTapes</code>. This marker indicates which page of results to retrieve. </para><para>If not specified, the first page of results is retrieved.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGUploadBufferCmdlet"> <summary> This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures. <para> The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGUploadBufferCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeCmdlet"> <summary> This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the <a>DescribeStorediSCSIVolumes</a> API. <para> The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the <code>Limit</code> field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeCmdlet.Limit"> <summary> <para> <para>Specifies that the list of volumes returned be limited to the specified number of items.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeCmdlet.Marker"> <summary> <para> <para>A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeInitiatorsCmdlet"> <summary> This operation lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeInitiatorsCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes for the gateway.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeRecoveryPointCmdlet"> <summary> This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture. <para> Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVolumeRecoveryPointCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDevicesCmdlet"> <summary> Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information. <para> The list of VTL devices must be from one gateway. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDevicesCmdlet.VTLDeviceARNs"> <summary> <para> <para>An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.</para><note>All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDevicesCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDevicesCmdlet.Limit"> <summary> <para> <para>Specifies that the number of VTL devices described be limited to the specified number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGVTLDevicesCmdlet.Marker"> <summary> <para> <para>An opaque string that indicates the position at which to begin describing the VTL devices.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.GetSGWorkingStorageCmdlet"> <summary> This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead. <note><para> Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway. </para></note><para> The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.GetSGWorkingStorageCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet"> <summary> This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture. <note>Cache storage must be allocated to the gateway before you can create a cached volume. Use the <a>AddCache</a> operation to add cache storage to a gateway. </note><para> In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.ClientToken"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.NetworkInterfaceId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.SnapshotId"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.TargetName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.VolumeSizeInBytes"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGCachediSCSIVolumeCmdlet.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.SG.NewSGSnapshotCmdlet"> <summary> This operation initiates a snapshot of a volume. <para> AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html">Working With Snapshots in the AWS Storage Gateway Console</a>. </para><para> In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. </para><note>To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html">EC2 API reference</a>.</note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotCmdlet.SnapshotDescription"> <summary> <para> <para>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the <b>Description</b> field, and in the AWS Storage Gateway snapshot <b>Details</b> pane, <b>Description</b> field</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotCmdlet.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.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet"> <summary> This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ). <para> A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use <a>ListVolumeRecoveryPoints</a>. </para><para> In the <code>CreateSnapshotFromVolumeRecoveryPoint</code> request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. </para><note><para> To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in <i>Amazon Elastic Compute Cloud API Reference</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet.SnapshotDescription"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet.VolumeARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGSnapshotFromVolumeRecoveryPointCmdlet.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.SG.NewSGStorediSCSIVolumeCmdlet"> <summary> This operation creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture. <para> The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. </para><para> In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.DiskId"> <summary> <para> <para>The unique identifier for the gateway local disk that is configured as a stored volume. Use <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html">ListLocalDisks</a> to list disk IDs for a gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.NetworkInterfaceId"> <summary> <para> <para>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway.</para><para><i>Valid Values</i>: A valid IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.PreserveExistingData"> <summary> <para> <para>Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.</para><para><i>Valid Values</i>: true, false</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.SnapshotId"> <summary> <para> <para>The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.TargetName"> <summary> <para> <para>The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying <code>TargetName</code> as <i>myvolume</i> results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGStorediSCSIVolumeCmdlet.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.SG.NewSGTapesCmdlet"> <summary> Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. <note>Cache storage must be allocated to the gateway before you can create virtual tapes. Use the <a>AddCache</a> operation to add cache storage to a gateway. </note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapesCmdlet.ClientToken"> <summary> <para> <para>A unique identifier that you use to retry a request. If you retry a request, use the same <code>ClientToken</code> you specified in the initial request.</para><note>Using the same <code>ClientToken</code> prevents creating the tape multiple times.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapesCmdlet.GatewayARN"> <summary> <para> <para>The unique Amazon Resource Name(ARN) that represents the gateway to associate the virtual tapes with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapesCmdlet.NumTapesToCreate"> <summary> <para> <para>The number of virtual tapes you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapesCmdlet.TapeBarcodePrefix"> <summary> <para> <para>A prefix you append to the barcode of the virtual tape you are creating. This makes a barcode unique.</para><note>The prefix must be 1 to 4 characters in length and must be upper-case letters A-Z.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapesCmdlet.TapeSizeInBytes"> <summary> <para> <para>The size, in bytes, of the virtual tapes you want to create.</para><note>The size must be gigabyte (1024*1024*1024 byte) aligned.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.NewSGTapesCmdlet.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.SG.RemoveSGBandwidthRateLimitCmdlet"> <summary> This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGBandwidthRateLimitCmdlet.BandwidthType"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGBandwidthRateLimitCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGBandwidthRateLimitCmdlet.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.SG.RemoveSGChapCredentialsCmdlet"> <summary> This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGChapCredentialsCmdlet.InitiatorName"> <summary> <para> <para>The iSCSI initiator that connects to the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGChapCredentialsCmdlet.TargetARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for specified VolumeARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGChapCredentialsCmdlet.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.SG.RemoveSGGatewayCmdlet"> <summary> This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer. <para> After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment. </para><important><para> You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the <a href="http://aws.amazon.com/storagegateway"> AWS Storage Gateway Detail Page</a>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGGatewayCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGGatewayCmdlet.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.SG.RemoveSGResourceTagCmdlet"> <summary> This operation removes one or more tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource you want to remove the tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGResourceTagCmdlet.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.SG.RemoveSGSnapshotScheduleCmdlet"> <summary> This operation deletes a snapshot of a volume. <para> You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API enables you to delete a snapshot schedule for a volume. For more information, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html">Working with Snapshots</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the volume by providing its Amazon Resource Name (ARN). </para><note><para> To list or delete a snapshot, you must use the Amazon EC2 API. in <i>Amazon Elastic Compute Cloud API Reference</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGSnapshotScheduleCmdlet.VolumeARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGSnapshotScheduleCmdlet.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.SG.RemoveSGTapeCmdlet"> <summary> Deletes the specified virtual tape. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeCmdlet.GatewayARN"> <summary> <para> <para>The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeCmdlet.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.SG.RemoveSGTapeArchiveCmdlet"> <summary> Deletes the specified virtual tape from the virtual tape shelf (VTS). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeArchiveCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGTapeArchiveCmdlet.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.SG.RemoveSGVolumeCmdlet"> <summary> This operation deletes the specified gateway volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. <para> Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>. </para><para> In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGVolumeCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.RemoveSGVolumeCmdlet.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.SG.ResetSGCacheCmdlet"> <summary> This operation resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. <important><para> If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.ResetSGCacheCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.ResetSGCacheCmdlet.PassThru"> <summary> Returns the value passed to the GatewayARN parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.ResetSGCacheCmdlet.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.SG.StartSGGatewayCmdlet"> <summary> This operation starts a gateway that you previously shut down (see <a>ShutdownGateway</a>). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups. <note>When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call <a>DescribeGatewayInformation</a> and check the status before making any additional API calls. For more information, see <a>ActivateGateway</a>.</note><para> To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StartSGGatewayCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StartSGGatewayCmdlet.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.SG.StopSGArchivalCmdlet"> <summary> Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGArchivalCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGArchivalCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGArchivalCmdlet.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.SG.StopSGGatewayCmdlet"> <summary> This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request. <para> The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM. </para><note>If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.</note><para> After the gateway is shutdown, you cannot call any other API except <a>StartGateway</a>, <a>DescribeGatewayInformation</a>, and <a>ListGateways</a>. For more information, see <a>ActivateGateway</a>. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken. </para><note>When you make a shutdown request, you will get a <code>200 OK</code> success response immediately. However, it might take some time for the gateway to shut down. You can call the <a>DescribeGatewayInformation</a> API to check the status. For more information, see <a>ActivateGateway</a>.</note><para> If do not intend to use the gateway again, you must delete the gateway (using <a>DeleteGateway</a>) to no longer pay software charges associated with the gateway. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGGatewayCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGGatewayCmdlet.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.SG.StopSGRetrievalCmdlet"> <summary> Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGRetrievalCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGRetrievalCmdlet.TapeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.StopSGRetrievalCmdlet.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.SG.UpdateSGBandwidthRateLimitCmdlet"> <summary> This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. <para> By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. </para><para> To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet.AverageDownloadRateLimitInBitsPerSec"> <summary> <para> <para>The average download bandwidth rate limit in bits per second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet.AverageUploadRateLimitInBitsPerSec"> <summary> <para> <para>The average upload bandwidth rate limit in bits per second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGBandwidthRateLimitCmdlet.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.SG.UpdateSGChapCredentialsCmdlet"> <summary> This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. <important><para> When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialsCmdlet.InitiatorName"> <summary> <para> <para>The iSCSI initiator that connects to the target.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialsCmdlet.SecretToAuthenticateInitiator"> <summary> <para> <para>The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.</para><note>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialsCmdlet.SecretToAuthenticateTarget"> <summary> <para> <para>The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).</para><para>Byte constraints: Minimum bytes of 12. Maximum bytes of 16.</para><note>The secret key must be between 12 and 16 bytes when encoded in UTF-8.</note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialsCmdlet.TargetARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return the TargetARN for specified VolumeARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGChapCredentialsCmdlet.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.SG.UpdateSGGatewayInformationCmdlet"> <summary> This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.GatewayName"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.GatewayTimezone"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewayInformationCmdlet.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.SG.UpdateSGGatewaySoftwareNowCmdlet"> <summary> This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software update. <note>When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete. You can call <a>DescribeGatewayInformation</a> to verify the gateway is in the <code>STATE_RUNNING</code> state.</note><important>A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings">Customizing Your Windows iSCSI Settings</a> and <a href="http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings">Customizing Your Linux iSCSI Settings</a>, respectively.</important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewaySoftwareNowCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGGatewaySoftwareNowCmdlet.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.SG.UpdateSGMaintenanceStartTimeCmdlet"> <summary> This operation updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.DayOfWeek"> <summary> <para> <para>The maintenance start time day of the week.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.GatewayARN"> <summary> <para> Documentation for this parameter is not currently available; please refer to the service API documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.HourOfDay"> <summary> <para> <para>The hour component of the maintenance start time represented as <i>hh</i>, where <i>hh</i> is the hour (00 to 23). The hour of the day is in the time zone of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.MinuteOfHour"> <summary> <para> <para>The minute component of the maintenance start time represented as <i>mm</i>, where <i>mm</i> is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGMaintenanceStartTimeCmdlet.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.SG.UpdateSGSnapshotScheduleCmdlet"> <summary> This operation updates a snapshot schedule configured for a gateway volume. <para> The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. </para><para> In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.Description"> <summary> <para> <para>Optional description of the snapshot that overwrites the existing description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.RecurrenceInHours"> <summary> <para> <para>Frequency of snapshots. Specify the number of hours between snapshots.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.StartAt"> <summary> <para> <para>The hour of the day at which the snapshot schedule begins represented as <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time zone of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.VolumeARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGSnapshotScheduleCmdlet.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.SG.UpdateSGVTLDeviceTypeCmdlet"> <summary> This operation updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGVTLDeviceTypeCmdlet.DeviceType"> <summary> <para> <para>The type of medium changer you want to select.</para><para><i>Valid Values</i>: "STK-L700", "AWS-Gateway-VTL"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGVTLDeviceTypeCmdlet.VTLDeviceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the medium changer you want to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SG.UpdateSGVTLDeviceTypeCmdlet.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.WAF.GetWAFByteMatchSetCmdlet"> <summary> Returns the <a>ByteMatchSet</a> specified by <code>ByteMatchSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFByteMatchSetCmdlet.ByteMatchSetId"> <summary> <para> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to get. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFByteMatchSetListCmdlet"> <summary> Returns an array of <a>ByteMatchSetSummary</a> objects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFByteMatchSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>ByteMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>ByteMatchSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>ByteMatchSet</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFByteMatchSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>ByteMatchSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListByteMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ByteMatchSets</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFChangeTokenCmdlet"> <summary> When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. <para> Each create, update, or delete request must use a unique change token. If your application submits a <code>GetChangeToken</code> request and then submits a second <code>GetChangeToken</code> request before submitting a create, update, or delete request, the second <code>GetChangeToken</code> request returns the same value as the first <code>GetChangeToken</code> request. </para><para> When you use a change token in a create, update, or delete request, the status of the change token changes to <code>PENDING</code>, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use <code>GetChangeTokenStatus</code> to determine the status of your change token. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFChangeTokenStatusCmdlet"> <summary> Returns the status of a <code>ChangeToken</code> that you got by calling <a>GetChangeToken</a>. <code>ChangeTokenStatus</code> is one of the following values: <ul><li><code>PROVISIONED</code>: You requested the change token by calling <code>GetChangeToken</code>, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.</li><li><code>PENDING</code>: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.</li><li><code>IN_SYNC</code>: Propagation is complete.</li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFChangeTokenStatusCmdlet.ChangeToken"> <summary> <para> <para>The change token for which you want to get the status. This change token was previously returned in the <code>GetChangeToken</code> response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFIPSetCmdlet"> <summary> Returns the <a>IPSet</a> that is specified by <code>IPSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFIPSetCmdlet.IPSetId"> <summary> <para> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to get. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFIPSetListCmdlet"> <summary> Returns an array of <a>IPSetSummary</a> objects in the response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFIPSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>IPSet</code> objects that you want AWS WAF to return for this request. If you have more <code>IPSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>IPSet</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFIPSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>IPSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ByteMatchSets</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFRuleCmdlet"> <summary> Returns the <a>Rule</a> that is specified by the <code>RuleId</code> that you included in the <code>GetRule</code> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFRuleListCmdlet"> <summary> Returns an array of <a>RuleSummary</a> objects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFRuleListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFRuleListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFSampledRequestListCmdlet"> <summary> Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours. <para><code>GetSampledRequests</code> returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, <code>GetSampledRequests</code> returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFSampledRequestListCmdlet.TimeWindow_EndTime"> <summary> <para> <para>The end of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFSampledRequestListCmdlet.RuleId"> <summary> <para> <para><code>RuleId</code> is one of two values:</para><ul><li>The <code>RuleId</code> of the <code>Rule</code> for which you want <code>GetSampledRequests</code> to return a sample of requests.</li><li><code>Default_Action</code>, which causes <code>GetSampledRequests</code> to return a sample of the requests that didn't match any of the rules in the specified <code>WebACL</code>.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFSampledRequestListCmdlet.TimeWindow_StartTime"> <summary> <para> <para>The beginning of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFSampledRequestListCmdlet.WebAclId"> <summary> <para> <para>The <code>WebACLId</code> of the <code>WebACL</code> for which you want <code>GetSampledRequests</code> to return a sample of requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFSampledRequestListCmdlet.MaxItem"> <summary> <para> <para>The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFSqlInjectionMatchSetCmdlet"> <summary> Returns the <a>SqlInjectionMatchSet</a> that is specified by <code>SqlInjectionMatchSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFSqlInjectionMatchSetCmdlet.SqlInjectionMatchSetId"> <summary> <para> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to get. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFSqlInjectionMatchSetListCmdlet"> <summary> Returns an array of <a>SqlInjectionMatchSet</a> objects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFSqlInjectionMatchSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <a>SqlInjectionMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>SqlInjectionMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFSqlInjectionMatchSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <a>SqlInjectionMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SqlInjectionMatchSets</code>. For the second and subsequent <code>ListSqlInjectionMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SqlInjectionMatchSets</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFWebACLCmdlet"> <summary> Returns the <a>WebACL</a> that is specified by <code>WebACLId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFWebACLCmdlet.WebACLId"> <summary> <para> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to get. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.GetWAFWebACLListCmdlet"> <summary> Returns an array of <a>WebACLSummary</a> objects in the response. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFWebACLListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>WebACL</code> objects that you want AWS WAF to return for this request. If you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>WebACL</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.GetWAFWebACLListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>WebACL</code> objects. For the second and subsequent <code>ListWebACLs</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>WebACL</code> objects.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.NewWAFByteMatchSetCmdlet"> <summary> Creates a <code>ByteMatchSet</code>. You then use <a>UpdateByteMatchSet</a> to identify the part of a web request that you want AWS WAF to inspect, such as the values of the <code>User-Agent</code> header or the query string. For example, you can create a <code>ByteMatchSet</code> that matches any requests with <code>User-Agent</code> headers that contain the string <code>BadBot</code>. You can then configure AWS WAF to reject those requests. <para> To create and configure a <code>ByteMatchSet</code>, perform the following steps: </para><ol><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateByteMatchSet</code> request.</li><li>Submit a <code>CreateByteMatchSet</code> request.</li><li>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request.</li><li>Submit an <a>UpdateByteMatchSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.</li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFByteMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFByteMatchSetCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFByteMatchSetCmdlet.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.WAF.NewWAFIPSetCmdlet"> <summary> Creates an <a>IPSet</a>, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that contains those IP addresses and then configure AWS WAF to block the requests. <para> To create and configure an <code>IPSet</code>, perform the following steps: </para><ol><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateIPSet</code> request.</li><li>Submit a <code>CreateIPSet</code> request.</li><li>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</li><li>Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for.</li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFIPSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFIPSetCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>IPSet</a>. You can't change <code>Name</code> after you create the <code>IPSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFIPSetCmdlet.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.WAF.NewWAFRuleCmdlet"> <summary> Creates a <code>Rule</code>, which contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a <code>Rule</code>: <ul><li>An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code></li><li>A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header</li></ul><para> You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to blocks requests that satisfy the <code>Rule</code>. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. </para><para> To create and configure a <code>Rule</code>, perform the following steps: </para><ol><li>Create and update the predicates that you want to include in the <code>Rule</code>. For more information, see <a>CreateByteMatchSet</a>, <a>CreateIPSet</a>, and <a>CreateSqlInjectionMatchSet</a>.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request.</li><li>Submit a <code>CreateRule</code> request.</li><li>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request.</li><li>Submit an <code>UpdateRule</code> request to specify the predicates that you want to include in the <code>Rule</code>.</li><li>Create and update a <code>WebACL</code> that contains the <code>Rule</code>. For more information, see <a>CreateWebACL</a>.</li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFRuleCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFRuleCmdlet.MetricName"> <summary> <para> <para>A friendly name or description for the metrics for this <code>Rule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>Rule</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFRuleCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>Rule</a>. You can't change the name of a <code>Rule</code> after you create it.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.NewWAFSqlInjectionMatchSetCmdlet"> <summary> Creates a <a>SqlInjectionMatchSet</a>, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. <para> To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps: </para><ol><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSqlInjectionMatchSet</code> request.</li><li>Submit a <code>CreateSqlInjectionMatchSet</code> request.</li><li>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateSqlInjectionMatchSet</a> request.</li><li>Submit an <a>UpdateSqlInjectionMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.</li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFSqlInjectionMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFSqlInjectionMatchSetCmdlet.Name"> <summary> <para> <para>A friendly name or description for the <a>SqlInjectionMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>SqlInjectionMatchSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFSqlInjectionMatchSetCmdlet.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.WAF.NewWAFWebACLCmdlet"> <summary> Creates a <code>WebACL</code>, which contains the <code>Rules</code> that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates <code>Rules</code> in order based on the value of <code>Priority</code> for each <code>Rule</code>. <para> You also specify a default action, either <code>ALLOW</code> or <code>BLOCK</code>. If a web request doesn't match any of the <code>Rules</code> in a <code>WebACL</code>, AWS WAF responds to the request with the default action. </para><para> To create and configure a <code>WebACL</code>, perform the following steps: </para><ol><li>Create and update the <code>ByteMatchSet</code> objects and other predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>.</li><li>Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateWebACL</code> request.</li><li>Submit a <code>CreateWebACL</code> request.</li><li>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request.</li><li>Submit an <a>UpdateWebACL</a> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution.</li></ol><para> For more information about how to use the AWS WAF API, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFWebACLCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFWebACLCmdlet.MetricName"> <summary> <para> <para>A friendly name or description for the metrics for this <code>WebACL</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change <code>MetricName</code> after you create the <code>WebACL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFWebACLCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>WebACL</a>. You can't change <code>Name</code> after you create the <code>WebACL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.NewWAFWebACLCmdlet.DefaultAction_Type"> <summary> <para> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following:</para><ul><li><code>ALLOW</code>: AWS WAF allows requests</li><li><code>BLOCK</code>: AWS WAF blocks requests</li><li><code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>.</li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFByteMatchSetCmdlet"> <summary> Permanently deletes a <a>ByteMatchSet</a>. You can't delete a <code>ByteMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>ByteMatchTuple</a> objects (any filters). <para> If you just want to remove a <code>ByteMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete a <code>ByteMatchSet</code>, perform the following steps: </para><ol><li>Update the <code>ByteMatchSet</code> to remove filters, if any. For more information, see <a>UpdateByteMatchSet</a>.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteByteMatchSet</code> request.</li><li>Submit a <code>DeleteByteMatchSet</code> request.</li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFByteMatchSetCmdlet.ByteMatchSetId"> <summary> <para> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to delete. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFByteMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFByteMatchSetCmdlet.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.WAF.RemoveWAFIPSetCmdlet"> <summary> Permanently deletes an <a>IPSet</a>. You can't delete an <code>IPSet</code> if it's still used in any <code>Rules</code> or if it still includes any IP addresses. <para> If you just want to remove an <code>IPSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete an <code>IPSet</code> from AWS WAF, perform the following steps: </para><ol><li>Update the <code>IPSet</code> to remove IP address ranges, if any. For more information, see <a>UpdateIPSet</a>.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteIPSet</code> request.</li><li>Submit a <code>DeleteIPSet</code> request.</li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFIPSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFIPSetCmdlet.IPSetId"> <summary> <para> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to delete. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFIPSetCmdlet.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.WAF.RemoveWAFRuleCmdlet"> <summary> Permanently deletes a <a>Rule</a>. You can't delete a <code>Rule</code> if it's still used in any <code>WebACL</code> objects or if it still includes any predicates, such as <code>ByteMatchSet</code> objects. <para> If you just want to remove a <code>Rule</code> from a <code>WebACL</code>, use <a>UpdateWebACL</a>. </para><para> To permanently delete a <code>Rule</code> from AWS WAF, perform the following steps: </para><ol><li>Update the <code>Rule</code> to remove predicates, if any. For more information, see <a>UpdateRule</a>.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRule</code> request.</li><li>Submit a <code>DeleteRule</code> request.</li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFRuleCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFRuleCmdlet.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.WAF.RemoveWAFSqlInjectionMatchSetCmdlet"> <summary> Permanently deletes a <a>SqlInjectionMatchSet</a>. You can't delete a <code>SqlInjectionMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>SqlInjectionMatchTuple</a> objects. <para> If you just want to remove a <code>SqlInjectionMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete a <code>SqlInjectionMatchSet</code> from AWS WAF, perform the following steps: </para><ol><li>Update the <code>SqlInjectionMatchSet</code> to remove filters, if any. For more information, see <a>UpdateSqlInjectionMatchSet</a>.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSqlInjectionMatchSet</code> request.</li><li>Submit a <code>DeleteSqlInjectionMatchSet</code> request.</li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFSqlInjectionMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFSqlInjectionMatchSetCmdlet.SqlInjectionMatchSetId"> <summary> <para> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to delete. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFSqlInjectionMatchSetCmdlet.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.WAF.RemoveWAFWebACLCmdlet"> <summary> Permanently deletes a <a>WebACL</a>. You can't delete a <code>WebACL</code> if it still contains any <code>Rules</code>. <para> To delete a <code>WebACL</code>, perform the following steps: </para><ol><li>Update the <code>WebACL</code> to remove <code>Rules</code>, if any. For more information, see <a>UpdateWebACL</a>.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteWebACL</code> request.</li><li>Submit a <code>DeleteWebACL</code> request.</li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFWebACLCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFWebACLCmdlet.WebACLId"> <summary> <para> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to delete. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.RemoveWAFWebACLCmdlet.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.WAF.UpdateWAFByteMatchSetCmdlet"> <summary> Inserts or deletes <a>ByteMatchTuple</a> objects (filters) in a <a>ByteMatchSet</a>. For each <code>ByteMatchTuple</code> object, you specify the following values: <ul><li>Whether to insert or delete the object from the array. If you want to change a <code>ByteMatchSetUpdate</code> object, you delete the existing object and add a new one.</li><li>The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the <code>User-Agent</code> header. </li><li>The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see <code>TargetString</code> in the <a>ByteMatchTuple</a> data type. </li><li>Where to look, such as at the beginning or the end of a query string.</li><li>Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.</li></ul><para> For example, you can add a <code>ByteMatchSetUpdate</code> object that matches web requests in which <code>User-Agent</code> headers contain the string <code>BadBot</code>. You can then configure AWS WAF to block those requests. </para><para> To create and configure a <code>ByteMatchSet</code>, perform the following steps: </para><ol><li>Create a <code>ByteMatchSet.</code> For more information, see <a>CreateByteMatchSet</a>.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request.</li><li>Submit an <code>UpdateByteMatchSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.</li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFByteMatchSetCmdlet.ByteMatchSetId"> <summary> <para> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to update. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFByteMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFByteMatchSetCmdlet.Update"> <summary> <para> <para>An array of <code>ByteMatchSetUpdate</code> objects that you want to insert into or delete from a <a>ByteMatchSet</a>. For more information, see the applicable data types:</para><ul><li><a>ByteMatchSetUpdate</a>: Contains <code>Action</code> and <code>ByteMatchTuple</code></li><li><a>ByteMatchTuple</a>: Contains <code>FieldToMatch</code>, <code>PositionalConstraint</code>, <code>TargetString</code>, and <code>TextTransformation</code></li><li><a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFByteMatchSetCmdlet.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.WAF.UpdateWAFIPSetCmdlet"> <summary> Inserts or deletes <a>IPSetDescriptor</a> objects in an <code>IPSet</code>. For each <code>IPSetDescriptor</code> object, you specify the following values: <ul><li>Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code> object, you delete the existing object and add a new one.</li><li>The IP address version, <code>IPv4</code>. </li><li>The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code> (for the individual IP address <code>192.0.2.44</code>). </li></ul><para> AWS WAF supports /8, /16, /24, and /32 IP address ranges. For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. </para><para> You use an <code>IPSet</code> to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that specifies those IP addresses, and then configure AWS WAF to block the requests. </para><para> To create and configure an <code>IPSet</code>, perform the following steps: </para><ol><li>Submit a <a>CreateIPSet</a> request.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</li><li>Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for.</li></ol><para> When you update an <code>IPSet</code>, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. </para><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFIPSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFIPSetCmdlet.IPSetId"> <summary> <para> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to update. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFIPSetCmdlet.Update"> <summary> <para> <para>An array of <code>IPSetUpdate</code> objects that you want to insert into or delete from an <a>IPSet</a>. For more information, see the applicable data types:</para><ul><li><a>IPSetUpdate</a>: Contains <code>Action</code> and <code>IPSetDescriptor</code></li><li><a>IPSetDescriptor</a>: Contains <code>Type</code> and <code>Value</code></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFIPSetCmdlet.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.WAF.UpdateWAFRuleCmdlet"> <summary> Inserts or deletes <a>Predicate</a> objects in a <code>Rule</code>. Each <code>Predicate</code> object identifies a predicate, such as a <a>ByteMatchSet</a> or an <a>IPSet</a>, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a <code>Rule</code>: <ul><li>A <code>ByteMatchSet</code> that matches the value <code>BadBot</code> in the <code>User-Agent</code> header</li><li>An <code>IPSet</code> that matches the IP address <code>192.0.2.44</code></li></ul><para> You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to block requests that satisfy the <code>Rule</code>. For a request to be blocked, the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code><i>and</i> the request must originate from the IP address 192.0.2.44. </para><para> To create and configure a <code>Rule</code>, perform the following steps: </para><ol><li>Create and update the predicates that you want to include in the <code>Rule</code>.</li><li>Create the <code>Rule</code>. See <a>CreateRule</a>.</li><li>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request.</li><li>Submit an <code>UpdateRule</code> request to add predicates to the <code>Rule</code>.</li><li>Create and update a <code>WebACL</code> that contains the <code>Rule</code>. See <a>CreateWebACL</a>.</li></ol><para> If you want to replace one <code>ByteMatchSet</code> or <code>IPSet</code> with another, you delete the existing one and add the new one. </para><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFRuleCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <code>Rule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRule</code> and by <a>ListRules</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFRuleCmdlet.Update"> <summary> <para> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>Rule</a>. For more information, see the applicable data types:</para><ul><li><a>RuleUpdate</a>: Contains <code>Action</code> and <code>Predicate</code></li><li><a>Predicate</a>: Contains <code>DataId</code>, <code>Negated</code>, and <code>Type</code></li><li><a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFRuleCmdlet.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.WAF.UpdateWAFSqlInjectionMatchSetCmdlet"> <summary> Inserts or deletes <a>SqlInjectionMatchTuple</a> objects (filters) in a <a>SqlInjectionMatchSet</a>. For each <code>SqlInjectionMatchTuple</code> object, you specify the following values: <ul><li><code>Action</code>: Whether to insert the object into or delete the object from the array. To change a <code>SqlInjectionMatchTuple</code>, you delete the existing object and add a new one.</li><li><code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.</li><li><code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.</li></ul><para> You use <code>SqlInjectionMatchSet</code> objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a <code>SqlInjectionMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. </para><para> To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps: </para><ol><li>Submit a <a>CreateSqlInjectionMatchSet</a> request.</li><li>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</li><li>Submit an <code>UpdateSqlInjectionMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.</li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFSqlInjectionMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFSqlInjectionMatchSetCmdlet.SqlInjectionMatchSetId"> <summary> <para> <para>The <code>SqlInjectionMatchSetId</code> of the <code>SqlInjectionMatchSet</code> that you want to update. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFSqlInjectionMatchSetCmdlet.Update"> <summary> <para> <para>An array of <code>SqlInjectionMatchSetUpdate</code> objects that you want to insert into or delete from a <a>SqlInjectionMatchSet</a>. For more information, see the applicable data types:</para><ul><li><a>SqlInjectionMatchSetUpdate</a>: Contains <code>Action</code> and <code>SqlInjectionMatchTuple</code></li><li><a>SqlInjectionMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code></li><li><a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFSqlInjectionMatchSetCmdlet.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.WAF.UpdateWAFWebACLCmdlet"> <summary> Inserts or deletes <a>ActivatedRule</a> objects in a <code>WebACL</code>. Each <code>Rule</code> identifies web requests that you want to allow, block, or count. When you update a <code>WebACL</code>, you specify the following values: <ul><li>A default action for the <code>WebACL</code>, either <code>ALLOW</code> or <code>BLOCK</code>. AWS WAF performs the default action if a request doesn't match the criteria in any of the <code>Rules</code> in a <code>WebACL</code>.</li><li>The <code>Rules</code> that you want to add and/or delete. If you want to replace one <code>Rule</code> with another, you delete the existing <code>Rule</code> and add the new one.</li><li>For each <code>Rule</code>, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the <code>Rule</code>.</li><li>The order in which you want AWS WAF to evaluate the <code>Rules</code> in a <code>WebACL</code>. If you add more than one <code>Rule</code> to a <code>WebACL</code>, AWS WAF evaluates each request against the <code>Rules</code> in order based on the value of <code>Priority</code>. (The <code>Rule</code> that has the lowest value for <code>Priority</code> is evaluated first.) When a web request matches all of the predicates (such as <code>ByteMatchSets</code> and <code>IPSets</code>) in a <code>Rule</code>, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining <code>Rules</code> in the <code>WebACL</code>, if any. </li><li>The CloudFront distribution that you want to associate with the <code>WebACL</code>.</li></ul><para> To create and configure a <code>WebACL</code>, perform the following steps: </para><ol><li>Create and update the predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>.</li><li>Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>.</li><li>Create a <code>WebACL</code>. See <a>CreateWebACL</a>.</li><li>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request.</li><li>Submit an <code>UpdateWebACL</code> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution. </li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="http://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFWebACLCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFWebACLCmdlet.DefaultAction_Type"> <summary> <para> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following:</para><ul><li><code>ALLOW</code>: AWS WAF allows requests</li><li><code>BLOCK</code>: AWS WAF blocks requests</li><li><code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>.</li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFWebACLCmdlet.Update"> <summary> <para> <para>An array of updates to make to the <a>WebACL</a>.</para><para>An array of <code>WebACLUpdate</code> objects that you want to insert into or delete from a <a>WebACL</a>. For more information, see the applicable data types:</para><ul><li><a>WebACLUpdate</a>: Contains <code>Action</code> and <code>ActivatedRule</code></li><li><a>ActivatedRule</a>: Contains <code>Action</code>, <code>Priority</code>, and <code>RuleId</code></li><li><a>WafAction</a>: Contains <code>Type</code></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFWebACLCmdlet.WebACLId"> <summary> <para> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to update. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF.UpdateWAFWebACLCmdlet.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.WKS.GetWKSWorkspaceBundlesCmdlet"> <summary> Obtains information about the WorkSpace bundles that are available to your account in the specified region. <para> You can filter the results with either the <code>BundleIds</code> parameter, or the <code>Owner</code> parameter, but not both. </para><para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceBundlesCmdlet.BundleId"> <summary> <para> <para>An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceBundlesCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceBundlesCmdlet.Owner"> <summary> <para> <para>The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.</para><para>This contains one of the following values:</para><ul><li>null - Retrieves the bundles that belong to the account making the call.</li><li><code>AMAZON</code> - Retrieves the bundles that are provided by AWS.</li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceDirectoriesCmdlet"> <summary> Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account. <para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceDirectoriesCmdlet.DirectoryId"> <summary> <para> <para>An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspaceDirectoriesCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesCmdlet"> <summary> Obtains information about the specified WorkSpaces. <para> Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>, or <code>WorkspaceIds</code>, can be specified at a time. </para><para> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesCmdlet.BundleId"> <summary> <para> <para>The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesCmdlet.DirectoryId"> <summary> <para> <para>Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the <code>UserName</code> parameter. This parameter cannot be combined with any other filter parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesCmdlet.UserName"> <summary> <para> <para>Used with the <code>DirectoryId</code> parameter to specify the directory user for which to obtain the WorkSpace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesCmdlet.WorkspaceId"> <summary> <para> <para>An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.</para><para>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier returned by <a>CreateWorkspaces</a> is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesCmdlet.Limit"> <summary> <para> <para>The maximum number of items to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.GetWKSWorkspacesCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WKS.NewWKSWorkspaceCmdlet"> <summary> Creates one or more WorkSpaces. <note><para> This operation is asynchronous and returns before the WorkSpaces are created. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSWorkspaceCmdlet.Workspace"> <summary> <para> <para>An array of structures that specify the WorkSpaces to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.NewWKSWorkspaceCmdlet.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.WKS.ResetWKSWorkspaceCmdlet"> <summary> Rebuilds the specified WorkSpaces. <para> Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur: </para><ul><li>The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.</li><li>The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.</li></ul><para> To be able to rebuild a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code> or <code>ERROR</code>. </para><note><para> This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.ResetWKSWorkspaceCmdlet.Request"> <summary> <para> <para>An array of structures that specify the WorkSpaces to rebuild.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.ResetWKSWorkspaceCmdlet.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.WKS.RestartWKSWorkspaceCmdlet"> <summary> Reboots the specified WorkSpaces. <para> To be able to reboot a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code>, <code>IMPAIRED</code>, or <code>INOPERABLE</code>. </para><note><para> This operation is asynchronous and will return before the WorkSpaces have rebooted. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.RestartWKSWorkspaceCmdlet.Request"> <summary> <para> <para>An array of structures that specify the WorkSpaces to reboot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.RestartWKSWorkspaceCmdlet.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.WKS.StopWKSWorkspaceCmdlet"> <summary> Terminates the specified WorkSpaces. <para> Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. </para><para> You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>. </para><note><para> This operation is asynchronous and will return before the WorkSpaces have been completely terminated. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.StopWKSWorkspaceCmdlet.Request"> <summary> <para> <para>An array of structures that specify the WorkSpaces to terminate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WKS.StopWKSWorkspaceCmdlet.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.Common.AWSCmdletHistoryBuffer"> <summary> Execution history of AWS cmdlets, exposed as the $AWSHistory session variable. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCmdletHistoryBuffer.Commands"> <summary> Exposes the inner command trace to the shell </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCmdletHistoryBuffer.LastCommand"> <summary> Helper property to access the very last cmdlet that was run </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCmdletHistoryBuffer.LastServiceResponse"> <summary> Helper property to access the very last service response that was recorded on the last invocation. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCmdletHistoryBuffer.LastServiceRequest"> <summary> Helper property to access the very last service response that was recorded on the last invocation. </summary> </member> <member name="T:Amazon.PowerShell.Common.AWSCmdletHistory"> <summary> Records the responses and optionally requests that the cmdlet made, together with other diagnostic info. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCmdletHistory.LastServiceResponse"> <summary> Helper property to access the very last service response that was recorded </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCmdletHistory.LastServiceRequest"> <summary> Helper property to access the very last service request that was recorded, if request logging is turned on. </summary> </member> <member name="T:Amazon.PowerShell.Common.HistoryBuffer`1"> <summary> Simplistic fixed-size buffer implementation that can be used to keep track of cmdlet exec history and the request/response calls that each cmdlet makes. </summary> <typeparam name="T"></typeparam> </member> <member name="T:Amazon.PowerShell.Common.ClearAWSHistoryCmdlet"> <summary> Clears the contents of the AWS cmdlet history buffer ($AWSHistory) in the current shell. </summary> </member> <member name="T:Amazon.PowerShell.Common.SetAWSHistoryConfigurationCmdlet"> <summary> <para> Configures the $AWSHistory instance for the current session. </para> <para> A history buffer size of 0 disables overall AWS cmdlet activity recording and clears any data currently in the buffer. If the new size is smaller than the current data in the buffer, older records are deleted. </para> <para> By default, only service responses are recorded for a cmdlet. Use the -EnableRequestRecording switch to turn on tracing of service requests in the buffer. </para> </summary> </member> <member name="P:Amazon.PowerShell.Common.SetAWSHistoryConfigurationCmdlet.MaxCmdletHistory"> <summary> The maximum number of AWS cmdlet invocations that will be held in the history buffer. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetAWSHistoryConfigurationCmdlet.MaxServiceCallHistory"> <summary> The maximum number of service responses (and requests, if enabled) that will be recorded for a single AWS cmdlet. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetAWSHistoryConfigurationCmdlet.RecordServiceRequests"> <summary> If set, also records the service requests that a cmdlet makes. Default: Off. </summary> </member> <member name="T:Amazon.PowerShell.Common.AWSWebIdentityCredentials"> <summary> Represents an AWS session credential from the Web Identity Federation (WIF) API. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSWebIdentityCredentials.Expiration"> <summary> The time when the token will expire. </summary> </member> <member name="P:Amazon.PowerShell.Common.CmdletOutput.IsEnumerableOutput"> <summary> True if the output data is an enumerable collection that we should emit object-by-object to the pipe. Note that strings are enumerable so we must test for that specific case. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCommonArguments.Region"> <summary> Region for the command; the system name of the region or an AWSRegion instance </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCommonArguments.AccessKey"> <summary> The AWS access key for the user account </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCommonArguments.SecretKey"> <summary> The AWS secret key for the user account </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCommonArguments.SessionToken"> <summary> Session Token </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCommonArguments.ProfileName"> <summary> Retrieves credentials associated with the specified name from local storage </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCommonArguments.ProfilesLocation"> <summary> Location of the credentials file to use. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCommonArguments.Credential"> <summary> AWSCredentials object instance containing key information for the user account </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCommonArguments.NetworkCredential"> <summary> Used with SAML-based credential authentication. Contains the user's network credentials to be passed during authentication with the SAML endpoint. If not specified the default network credentials of the logged-in user will be used. </summary> </member> <member name="T:Amazon.PowerShell.Common.InitializeDefaultsCmdlet"> <summary> Sets AWS default credentials and region for the shell if previously persisted. If not previously persisted, requests the data from the interactive user. Persisted credentials are given the display/access name 'AWS PS Default'. On exit, the defaults can be found in the $StoredAWSCredentials and $StoredAWSRegion shell variables. </summary> </member> <member name="T:Amazon.PowerShell.Common.ClearDefaultsCmdlet"> <summary> Clears the persisted credentials associated with the credential profile names 'default' and 'AWS PS Default', plus any credentials and region data currently set in the session's shell variables. To clear the stored default credentials only, use the -SkipShell parameter. To affect the current shell only, use the -SkipProfileStore parameter. </summary> </member> <member name="P:Amazon.PowerShell.Common.ClearDefaultsCmdlet.SkipShell"> <summary> If set, the cmdlet will not clear the current shell state. </summary> </member> <member name="P:Amazon.PowerShell.Common.ClearDefaultsCmdlet.SkipProfileStore"> <summary> If set, the cmdlet will not clear the 'default' and 'AWS PS Default' profiles held in the credentials store. </summary> </member> <member name="T:Amazon.PowerShell.Common.GetAWSPowerShellVersionCmdlet"> <summary> Writes version and copyright information for the AWSPowerShell integration to the shell. If the ListServices switch is specified the services and their API versions supported by this module are also displayed. </summary> </member> <member name="P:Amazon.PowerShell.Common.GetAWSPowerShellVersionCmdlet.ListServiceVersionInfo"> <summary> If specified the cmdlet also lists all supported AWS services and their versions. </summary> </member> <member name="T:Amazon.PowerShell.Common.AWSPSCredentials"> <summary> Wrapper around a set of AWSCredentials (various leaf types) carrying credential data, logical name and source info. $StoredAWSCredentials points to an instance of this and the ToString() override allows us to display more useful info (the set name) than what AWSCredentials on its own can at present. </summary> </member> <member name="T:Amazon.PowerShell.Common.ICredentialsArgumentsMethods"> <summary> Performs a search amongst a chain of credential parameters and provider methods to arrive at at set of AWS credentials. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCredentialsArguments.AccessKey"> <summary> The AWS access key for the user account </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCredentialsArguments.SecretKey"> <summary> The AWS secret key for the user account </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCredentialsArguments.SessionToken"> <summary> Session Token </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCredentialsArguments.ProfileName"> <summary> Retrieves credentials associated with the specified name from local storage </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCredentialsArguments.ProfilesLocation"> <summary> Location of the credentials file to use. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCredentialsArguments.Credential"> <summary> AWSCredentials object instance containing key information for the user account </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSCredentialsArguments.NetworkCredential"> <summary> Used with SAML-based credential authentication. Contains the user's network credentials to be passed during authentication with the SAML endpoint. If not specified the default network credentials of the logged-in user will be used. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSRegionArguments.Region"> <summary> Region for the command; the system name of the region or an AWSRegion instance </summary> </member> <member name="M:Amazon.PowerShell.Common.SettingsStore.SaveSAMLCredentialProfile(System.String,System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Creates or updates a saml role profile. </summary> <param name="name">The name for the role profile</param> <param name="samlEndpointProfile"> The name of an existing saml endpoint profile containing the endpoint details </param> <param name="roleArn"> The arn of the role that should be assumed when this profile is used </param> <param name="domainUser"> Optional. Used if non-default network credentials should be used during authentication </param> <param name="region">A default region to assume</param> </member> <member name="T:Amazon.PowerShell.Common.NewCredentialsCmdlet"> <summary> Creates and returns an AWSCredentials object </summary> </member> <member name="T:Amazon.PowerShell.Common.SetCredentialsCmdlet"> <summary> Saves AWS credentials to persistent store (-StoreAs) or temporarily for the shell using shell variable $StoredAWSCredentials. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetCredentialsCmdlet.StoreAs"> <summary> The name to give to the credentials in local storage that can be used to retrieve those credentials when needed with the -ProfileName parameter on cmdlets. </summary> </member> <member name="T:Amazon.PowerShell.Common.ClearCredentialsCmdlet"> <summary> Clears the set of AWS credentials currently set as default in the shell or, if supplied with a name, deletes the set of credentials associated with the supplied name from the local credentials store. </summary> </member> <member name="P:Amazon.PowerShell.Common.ClearCredentialsCmdlet.ProfileName"> <summary> The name associated with a set of credentials in the local store that are to be deleted. If not specified, the default credentials in the shell are cleared. </summary> </member> <member name="T:Amazon.PowerShell.Common.GetCredentialsCmdlet"> <summary> Returns an AWSCredentials object initialized with from either credentials currently set as default in the shell or saved and associated with the supplied name from the local credential store. Optionally the cmdlet can list the names of all sets of credentials held in the store. </summary> </member> <member name="P:Amazon.PowerShell.Common.GetCredentialsCmdlet.ProfileName"> <summary> The name associated with the credentials in local storage </summary> </member> <member name="P:Amazon.PowerShell.Common.GetCredentialsCmdlet.ListProfiles"> <summary> Lists the names of all credentials data sets saved in local storage </summary> </member> <member name="T:Amazon.PowerShell.Common.SetAWSSamlEndpointProfileCmdlet"> <summary> Creates or updates an endpoint profile for SAML-based authentication. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetAWSSamlEndpointProfileCmdlet.Endpoint"> <summary> The endpoint that should be called when requesting temporary saml-based credentials. The endpoint should include all relying party and query strings required to call the authentication endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetAWSSamlEndpointProfileCmdlet.StoreAs"> <summary> The user-defined name to assign to the profile. This name is also used when creating/ accessing saml role profiles to obtain credentials, to reference the endpoint profile containing the endpoint to be called. </summary> </member> <member name="T:Amazon.PowerShell.Common.SetSamlCredentialsCmdlet"> <summary> Saves credential info vended by a saml-based federated identity endpoint to persistent store (-StoreAs) or temporarily for the shell using shell variable $StoredAWSCredentials. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetSamlCredentialsCmdlet.EndpointProfile"> <summary> The name of a saml endpoint profile that was previously registered using Set-AWSSamlEndpointProfile. The saml endpoint profile contains details of the actual endpoint that vends temporary saml-based credentials. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetSamlCredentialsCmdlet.PrincipalARN"> <summary> The ARN of the principal holding the role to be assumed when credentials are requested via SAML authentication. If used, the RoleARN parameter must also be set. If neither principal and role ARNs are supplied and the user has access to multiple roles, the cmdlet will prompt to select the role that should be referenced by the profile. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetSamlCredentialsCmdlet.RoleARN"> <summary> The ARN of the role to be assumed when credentials are requested via SAML authentication. If used, the RoleARN parameter must also be set. If neither principal and role ARNs are supplied and the user has access to multiple roles, the cmdlet will prompt to select the role that should be referenced by the profile. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetSamlCredentialsCmdlet.NetworkCredential"> <summary> Optional. Set if the credentials used to access the endpoint are not the current user's default network credentials. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetSamlCredentialsCmdlet.StoreAs"> <summary> The name to associate with the credential data. This name is used with the Set-AWSCredentials cmdlet to load the profile and obtain temporary AWS credentials based on the role and other data held in the profile. </summary> </member> <member name="T:Amazon.PowerShell.Common.GetCmdletNameCmdlet"> <summary> <para> Returns the name of the cmdlet that invokes a named Amazon Web Services service operation, optionally restricting the scope of the search to a specific service which can be identified using one or more words from the service name or the prefix applied to the nouns of cmdlets belonging to the service. </para> <para> Returns the names and corresponding service operations for a specific Amazon Web Services service which can be identified using one or more words from the service name or the prefix applied to the nouns of cmdlets belonging to the service. </para> <para> Returns the name of the cmdlet that is the equivalent to an AWS CLI command. In this mode a best-effort is made to extract the service and operation name data from the CLI command using known naming conventions and position rules used by the AWS CLI. </para> <para> If no match is made, no data is output. If the service cannot be identified, an error is displayed. </para> </summary> </member> <member name="M:Amazon.PowerShell.Common.GetCmdletNameCmdlet.FindCmdletsByService"> <summary> Obtains the names of all cmdlets belonging to the service(s) that match the search term supplied to the Service parameter. </summary> <returns>Collection of found cmdlets.</returns> </member> <member name="M:Amazon.PowerShell.Common.GetCmdletNameCmdlet.DiscoverServicePrefixes(System.String)"> <summary> Searches the set of base service client classes using either service name or deconstructed aws cli command to discover the prefix code for the service. If the user has supplied us with partial name data, we attempt to match as many services as possible. </summary> <paramref name="serviceName"/> <returns></returns> </member> <member name="M:Amazon.PowerShell.Common.GetCmdletNameCmdlet.ParseAwsCliCommand(System.String,System.String@,System.String@)"> <summary> Parses a typical aws cli command to extract the service name and operation. Some flexibility is allowed, to make it easy for users who are transcoding a cli sample to PowerShell. </summary> <param name="command"> Cli command to parse; as this was a parameter value that triggered a parameter set, we know it is not null. </param> <param name="serviceName"></param> <param name="operationName"></param> </member> <member name="M:Amazon.PowerShell.Common.GetCmdletNameCmdlet.DiscoverServiceCmdlets(System.String)"> <summary> Returns the subset of cmdlets belonging to a service by service prefix matching. </summary> <param name="servicePrefix"></param> <returns></returns> </member> <member name="P:Amazon.PowerShell.Common.GetCmdletNameCmdlet.ApiOperation"> <summary> <para> The name of the service operation (api) to search for. If not further restricted by service prefix or service name, all cmdlets across all services are inspected for a matching operation. </para> <para> By default the value supplied for this parameter is treated as a simple whole-word pattern to match. If the -MatchWithRegex switch is set the value is used as a regular expression. In both cases the search is case-insensitive/invariant culture. </para> </summary> </member> <member name="P:Amazon.PowerShell.Common.GetCmdletNameCmdlet.MatchWithRegex"> <summary> If set, the value supplied for the ApiOperation parameter is assumed to be a regular expression. By default, the value supplied for ApiOperation is treated as a simple case-insensitive whole-word pattern to match (the cmdlet will surround the ApiOperation value with ^ and $ tokens automatically). If the switch is set no modification of the supplied value is performed. </summary> </member> <member name="P:Amazon.PowerShell.Common.GetCmdletNameCmdlet.Service"> <summary> <para> Restricts the search to the cmdlets belonging to services that match the full or partial term supplied to the parameter value, which can be the service prefix (for example 'EC2') or one or more terms from the service name (for example 'compute' or 'compute cloud'). </para> <para> When partial names are used (as opposed to a prefix code) all services for which a match can be found are used to assist in the cmdlet results. A regular expression can always be supplied for the parameter value. </para> <para> If this is the only parameter supplied to the cmdlet, the output will list all of the cmdlets belonging to the services matching the search term, together with the corresponding service operation names. </para> </summary> </member> <member name="P:Amazon.PowerShell.Common.GetCmdletNameCmdlet.AwsCliCommand"> <summary> <para> The AWS CLI command to match. For example 'aws ec2 describe-instances'. </para> The cmdlet will make a best-effort to identify the owning service and the operation name by parsing the command using known conventions for the AWS CLI command format. The 'aws' prefix may be omitted and any AWS CLI options (identified by the prefix characters --) are skipped when parsing the value to identify the service code and operation name elements. </summary> </member> <member name="P:Amazon.PowerShell.Common.GetCmdletNameCmdlet.AllServiceCmdlets"> <summary> Returns all of the cmdlets in the toolset that make some form of service call. </summary> <returns></returns> </member> <member name="T:Amazon.PowerShell.Common.AddLoggerCmdlet"> <summary> Adds a single trace listener to the specified trace source. Given a name and file path, creates a TextWriterTraceListener with the given name and file path, and adds it to the listeners for the trace source. <para>If Source is not specified, 'Amazon' is assumed, which represents all SDK API calls. In the case where there are multiple listeners for multiple sources, Trace calls for an API will go to the most specific source only. For example, if one listener is added to 'Amazon.S3' and another on 'Amazon', then S3 calls will only be logged to the former listener.</para> </summary> </member> <member name="P:Amazon.PowerShell.Common.AddLoggerCmdlet.Name"> <summary> The name of the logger. </summary> </member> <member name="P:Amazon.PowerShell.Common.AddLoggerCmdlet.LogFilePath"> <summary> File path to write the log to. </summary> </member> <member name="P:Amazon.PowerShell.Common.AddLoggerCmdlet.TraceListener"> <summary> Specify a custom trace listener object. </summary> </member> <member name="P:Amazon.PowerShell.Common.AddLoggerCmdlet.Source"> <summary> Specify a source to log responses for. <para> Defaults to all responses (i.e. 'Amazon'). To limit to a specific service (for example DynamoDB), use 'Amazon.DynamoDB'.) </para> </summary> </member> <member name="T:Amazon.PowerShell.Common.RemoveLoggerCmdlet"> <summary> Remove a listener from and AWS API trace source. </summary> </member> <member name="P:Amazon.PowerShell.Common.RemoveLoggerCmdlet.Source"> <summary> Source to remove the listener from. <para> Examples: 'Amazon', or 'Amazon.DynamoDB'. </para> </summary> </member> <member name="P:Amazon.PowerShell.Common.RemoveLoggerCmdlet.Name"> <summary> Name of the trace listener to remove. </summary> </member> <member name="T:Amazon.PowerShell.Common.SetResponseLoggingCmdlet"> <summary> Modify when to produce log entries. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetResponseLoggingCmdlet.Level"> <summary> When to log responses. </summary> <remarks> Must be one of 'Always', 'OnError', or 'Never'. </remarks> </member> <member name="T:Amazon.PowerShell.Common.SetProxyCmdlet"> <summary> Sets AWS default proxy for the shell. </summary> </member> <member name="P:Amazon.PowerShell.Common.SetProxyCmdlet.Hostname"> <summary> Proxy server host </summary> </member> <member name="P:Amazon.PowerShell.Common.SetProxyCmdlet.Port"> <summary> Proxy server port </summary> </member> <member name="P:Amazon.PowerShell.Common.SetProxyCmdlet.Username"> <summary> Username to submit to the proxy server for authentication </summary> </member> <member name="P:Amazon.PowerShell.Common.SetProxyCmdlet.Password"> <summary> Password to submit to the proxy server for authentication </summary> </member> <member name="P:Amazon.PowerShell.Common.SetProxyCmdlet.Credential"> <summary> The credentials to submit to the proxy server for authentication </summary> </member> <member name="T:Amazon.PowerShell.Common.ClearProxyCmdlet"> <summary> Clears AWS default proxy for the shell. </summary> </member> <member name="T:Amazon.PowerShell.Common.ProxySettings"> <summary> Proxy settings for AWS cmdlets </summary> </member> <member name="P:Amazon.PowerShell.Common.ProxySettings.Hostname"> <summary> Proxy host </summary> </member> <member name="P:Amazon.PowerShell.Common.ProxySettings.Port"> <summary> Proxy port </summary> </member> <member name="P:Amazon.PowerShell.Common.ProxySettings.Credentials"> <summary> Proxy credentials </summary> </member> <member name="T:Amazon.PowerShell.Common.PSHelpers"> <summary> Collection of helpers for working with PowerShell objects </summary> </member> <member name="M:Amazon.PowerShell.Common.PSHelpers.PSPathToAbsolute(System.Management.Automation.PathIntrinsics,System.String)"> <summary> Converts a (possibly) relative path into an absolute one </summary> <param name="path">Current path</param> <param name="relativeOrAbsolutePath">Path to convert</param> <returns>Absolute path</returns> </member> <member name="T:Amazon.PowerShell.Common.PublicIpRangesCmdlet"> <summary> <para> Returns the collection of current public IP address ranges for Amazon Web Services. Each address range instance contains the service key, host region and IP address range (in CIDR notation). </para> <para> The cmdlet can optionally emit the set of currently known service keys, perform filtering of output by service key or region information or output the publication date and time of the current information. </para> <para> The information processed by this cmdlet is contained in a publicly accessible JSON-format file at https://ip-ranges.amazonaws.com/ip-ranges.json. The information in this file is generated from our internal system-of-record and is authoritative. You can expect it to change several times per week and should poll accordingly </para> <para> For more details on the public IP address range data for Amazon Web Services, see http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html. </para> </summary> </member> <member name="P:Amazon.PowerShell.Common.PublicIpRangesCmdlet.OutputServiceKeys"> <summary> If set the cmdlet emits the collection of currently-known service keys used in the address range data. </summary> </member> <member name="P:Amazon.PowerShell.Common.PublicIpRangesCmdlet.OutputPublicationDate"> <summary> If set the cmdlet emits the publication date and time of the data. </summary> </member> <member name="P:Amazon.PowerShell.Common.PublicIpRangesCmdlet.ServiceKey"> <summary> If set, contains one or more service keys to filter the output to. This parameter can be used in conjunction with the Region parameter to filter by region and service key. </summary> </member> <member name="P:Amazon.PowerShell.Common.PublicIpRangesCmdlet.Region"> <summary> If set, contains one or more region identifiers (e.g. "us-east-1", "global") to filter the output to. This parameter can be used in conjunction with the ServiceKey parameter to filter by region and service key. </summary> </member> <member name="T:Amazon.PowerShell.Common.SetDefaultRegionCmdlet"> <summary> Sets a default AWS region into the shell environment, accessible as $StoredAWSRegion. </summary> </member> <member name="T:Amazon.PowerShell.Common.ClearDefaultRegionCmdlet"> <summary> Clears any default AWS region set in the shell variable $StoredAWSRegion. </summary> </member> <member name="T:Amazon.PowerShell.Common.GetDefaultRegionCmdlet"> <summary> Returns the current default AWS region for this shell, if any, as held in the shell variable $StoredAWSRegion. </summary> </member> <member name="T:Amazon.PowerShell.Common.GetRegionCmdlet"> <summary> Returns the set of available AWS regions. </summary> </member> <member name="P:Amazon.PowerShell.Common.GetRegionCmdlet.SystemName"> <summary> <para> If set returns an AWSRegion instance corresponding to the specified system name (e.g. us-west-2). </para> <para> This parameter can also be used to return AWSRegion instances for the US GovCloud and China (Beijing) regions by specifying the relevant system name. </para> </summary> </member> <member name="P:Amazon.PowerShell.Common.GetRegionCmdlet.IncludeChina"> <summary> <para> Include the China (Beijing) region in the returned collection of AWSRegion instances. Note that use of this region requires an alternate set of credentials. </para> <para> This switch is ignored if the SystemName parameter is used to request a specific AWSRegion instance. To return the specific China (Beijing) region, specify a value of 'cn-north-1' for the SystemName parameter. </para> <para>Default: off.</para> </summary> </member> <member name="P:Amazon.PowerShell.Common.GetRegionCmdlet.IncludeGovCloud"> <summary> <para>If set the returned collection includes 'Gov Cloud' region(s).</para> <para>Default: off.</para> </summary> </member> <member name="P:Amazon.PowerShell.Common.GetRegionCmdlet.GovCloudOnly"> <summary> <para>If set the returned collection contains only the 'Gov Cloud' region(s).</para> <para>Default: off.</para> </summary> </member> <member name="T:Amazon.PowerShell.Common.AWSRegion"> <summary> Information about a specific AWS region </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSRegion.Region"> <summary> AWS system name for the region, for example 'us-west-2'. </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSRegion.Name"> <summary> The descriptive name for the region, for example 'US East (Virginia)' </summary> </member> <member name="P:Amazon.PowerShell.Common.AWSRegion.IsShellDefault"> <summary> Set to true if the region is the current default for the shell </summary> </member> <member name="T:Amazon.PowerShell.Properties.Resources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Amazon.PowerShell.Properties.Resources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Amazon.PowerShell.Properties.Resources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="M:Amazon.PowerShell.Utils.Extensions.ToKeyedCredentials(Amazon.Runtime.StoredProfileAWSCredentials)"> <summary> Creates an AWSCredentials instance with access and secret keys (and possibly token) from StoredProfileAWSCredentials. This avoids storing "reference" credentials (credentials that are pointing to a credentials source). </summary> <param name="stored"></param> <returns></returns> </member> <member name="T:Amazon.PowerShell.Utils.ProgressRunner"> <summary> Class that runs a task on a background thread and reports progress to the source cmdlet. Due to PowerShell limitation, cmdlet progress must be reported from the thread the cmdlet is executing on. </summary> </member> <member name="M:Amazon.PowerShell.Utils.ProgressRunner.#ctor(System.Management.Automation.Cmdlet)"> <summary> Constructs the runner. Source cmdlet is used to WriteProgress. All progress reports must be routed through the runner's Report method. </summary> <param name="sourceCmdlet"></param> </member> <member name="M:Amazon.PowerShell.Utils.ProgressRunner.Report(System.String,System.Int32,System.String)"> <summary> Reports the status to the shell </summary> <param name="activity"></param> <param name="percentComplete"></param> <param name="statusDescription"></param> </member> <member name="M:Amazon.PowerShell.Utils.ProgressRunner.Run(System.Action,Amazon.PowerShell.Utils.ProgressTracker)"> <summary> Starts execution of the main action and begins processing progress records. </summary> </member> <member name="M:Amazon.PowerShell.Utils.ProgressRunner.SafeRun(System.Action,Amazon.PowerShell.Utils.ProgressTracker)"> <summary> Calls the Run method and returns a CmdletOutput. If an exception was thrown, it will be stored in CmdletOutput.ErrorResponse </summary> <returns></returns> </member> </members> </doc> |