AWS.Tools.Lightsail.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Lightsail</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.LS.AddLSDiskCmdlet"> <summary> Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name. <para> The <code>attach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSDiskCmdlet.DiskName"> <summary> <para> <para>The unique Lightsail disk name (e.g., <code>my-disk</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSDiskCmdlet.DiskPath"> <summary> <para> <para>The disk path to expose to the instance (e.g., <code>/dev/xvdf</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSDiskCmdlet.InstanceName"> <summary> <para> <para>The name of the Lightsail instance where you want to utilize the storage disk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSDiskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.AddLSInstancesToLoadBalancerCmdlet"> <summary> Attaches one or more Lightsail instances to a load balancer. <para> After some time, the instances are attached to the load balancer and the health check status is available. </para><para> The <code>attach instances to load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSInstancesToLoadBalancerCmdlet.InstanceName"> <summary> <para> <para>An array of strings representing the instance name(s) you want to attach to your load balancer.</para><para>An instance must be <code>running</code> before you can attach it to your load balancer.</para><para>There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSInstancesToLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSInstancesToLoadBalancerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.AddLSLoadBalancerTlsCertificateCmdlet"> <summary> Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). <para> Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the <code>AttachLoadBalancerTlsCertificate</code> operation with the non-attached certificate, and it will replace the existing one and become the attached certificate. </para><para> The <code>attach load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSLoadBalancerTlsCertificateCmdlet.CertificateName"> <summary> <para> <para>The name of your SSL/TLS certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSLoadBalancerTlsCertificateCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer to which you want to associate the SSL/TLS certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSLoadBalancerTlsCertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.AddLSPeerVpcCmdlet"> <summary> Tries to peer the Lightsail VPC with the user's default VPC. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSPeerVpcCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.AddLSResourceTagCmdlet"> <summary> Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags">Lightsail Dev Guide</a>. <para> The <code>tag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSResourceTagCmdlet.ResourceName"> <summary> <para> <para>The name of the resource to which you are adding tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSResourceTagCmdlet.Tag"> <summary> <para> <para>The tag key and optional value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.AddLSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.CloseLSInstancePublicPortCmdlet"> <summary> Closes the public ports on a specific Amazon Lightsail instance. <para> The <code>close instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CloseLSInstancePublicPortCmdlet.PortInfo_FromPort"> <summary> <para> <para>The first port in the range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CloseLSInstancePublicPortCmdlet.InstanceName"> <summary> <para> <para>The name of the instance on which you're attempting to close the public ports.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CloseLSInstancePublicPortCmdlet.PortInfo_Protocol"> <summary> <para> <para>The protocol. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CloseLSInstancePublicPortCmdlet.PortInfo_ToPort"> <summary> <para> <para>The last port in the range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CloseLSInstancePublicPortCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.CopyLSSnapshotCmdlet"> <summary> Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CopyLSSnapshotCmdlet.SourceRegion"> <summary> <para> <para>The AWS Region where the source snapshot is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CopyLSSnapshotCmdlet.SourceSnapshotName"> <summary> <para> <para>The name of the source instance or disk snapshot to be copied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CopyLSSnapshotCmdlet.TargetSnapshotName"> <summary> <para> <para>The name of the new instance or disk snapshot to be created as a copy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.CopyLSSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.DismountLSDiskCmdlet"> <summary> Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk. <para> The <code>detach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.DismountLSDiskCmdlet.DiskName"> <summary> <para> <para>The unique name of the disk you want to detach from your instance (e.g., <code>my-disk</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.DismountLSDiskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.DismountLSInstancesFromLoadBalancerCmdlet"> <summary> Detaches the specified instances from a Lightsail load balancer. <para> This operation waits until the instances are no longer needed before they are detached from the load balancer. </para><para> The <code>detach instances from load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.DismountLSInstancesFromLoadBalancerCmdlet.InstanceName"> <summary> <para> <para>An array of strings containing the names of the instances you want to detach from the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.DismountLSInstancesFromLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the Lightsail load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.DismountLSInstancesFromLoadBalancerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.DismountLSStaticIpCmdlet"> <summary> Detaches a static IP from the Amazon Lightsail instance to which it is attached. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.DismountLSStaticIpCmdlet.StaticIpName"> <summary> <para> <para>The name of the static IP to detach from the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.DismountLSStaticIpCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.ExportLSSnapshotCmdlet"> <summary> Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the <code>create cloud formation stack</code> operation to create new Amazon EC2 instances. <para> Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. </para><para> The <code>export snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para><note><para> Use the <code>get instance snapshots</code> or <code>get disk snapshots</code> operations to get a list of snapshots that you can export to Amazon EC2. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.ExportLSSnapshotCmdlet.SourceSnapshotName"> <summary> <para> <para>The name of the instance or disk snapshot to be exported to Amazon EC2.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.ExportLSSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSActiveNameListCmdlet"> <summary> Returns the names of all active (not deleted) resources.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSActiveNameListCmdlet.PageToken"> <summary> <para> <para>A token used for paginating results from your get active names request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSBlueprintListCmdlet"> <summary> Returns the list of available instance images, or <i>blueprints</i>. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSBlueprintListCmdlet.IncludeInactive"> <summary> <para> <para>A Boolean value indicating whether to include inactive results in your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSBlueprintListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get blueprints request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSBundleListCmdlet"> <summary> Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or <i>instance</i>).<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSBundleListCmdlet.IncludeInactive"> <summary> <para> <para>A Boolean value that indicates whether to include inactive bundle results in your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSBundleListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get bundles request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSCloudFormationStackRecordCmdlet"> <summary> Returns the CloudFormation stack record created as a result of the <code>create cloud formation stack</code> operation. <para> An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSCloudFormationStackRecordCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results for your <code>get cloud formation stack records</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSDiskCmdlet"> <summary> Returns information about a specific block storage disk. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSDiskCmdlet.DiskName"> <summary> <para> <para>The name of the disk (e.g., <code>my-disk</code>).</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSDiskListCmdlet"> <summary> Returns information about all block storage disks in your AWS account and region. <para> If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSDiskListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your GetDisks request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSDiskSnapshotCmdlet"> <summary> Returns information about a specific block storage disk snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSDiskSnapshotCmdlet.DiskSnapshotName"> <summary> <para> <para>The name of the disk snapshot (e.g., <code>my-disk-snapshot</code>).</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSDiskSnapshotListCmdlet"> <summary> Returns information about all block storage disk snapshots in your AWS account and region. <para> If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSDiskSnapshotListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your GetDiskSnapshots request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSDomainCmdlet"> <summary> Returns information about a specific domain recordset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSDomainCmdlet.DomainName"> <summary> <para> <para>The domain name for which your want to return information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSDomainListCmdlet"> <summary> Returns a list of all domains in the user's account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSDomainListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get domains request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSExportSnapshotRecordCmdlet"> <summary> Returns the export snapshot record created as a result of the <code>export snapshot</code> operation. <para> An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the <code>create cloud formation stack</code> operation. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSExportSnapshotRecordCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results for your <code>get export snapshot records</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceCmdlet"> <summary> Returns information about a specific Amazon Lightsail instance, which is a virtual private server. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceCmdlet.InstanceName"> <summary> <para> <para>The name of the instance.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceAccessDetailCmdlet"> <summary> Returns temporary SSH keys you can use to connect to a specific virtual private server, or <i>instance</i>. <para> The <code>get instance access details</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceAccessDetailCmdlet.InstanceName"> <summary> <para> <para>The name of the instance to access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceAccessDetailCmdlet.Protocol"> <summary> <para> <para>The protocol to use to connect to your instance. Defaults to <code>ssh</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceListCmdlet"> <summary> Returns information about all Amazon Lightsail virtual private servers, or <i>instances</i>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get instances request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceMetricDataCmdlet"> <summary> Returns the data points for the specified Amazon Lightsail instance metric, given an instance name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceMetricDataCmdlet.EndTime"> <summary> <para> <para>The end time of the time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceMetricDataCmdlet.InstanceName"> <summary> <para> <para>The name of the instance for which you want to get metrics data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceMetricDataCmdlet.MetricName"> <summary> <para> <para>The metric name to get data about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceMetricDataCmdlet.Period"> <summary> <para> <para>The granularity, in seconds, of the returned data points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceMetricDataCmdlet.StartTime"> <summary> <para> <para>The start time of the time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceMetricDataCmdlet.Statistic"> <summary> <para> <para>The instance statistics. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceMetricDataCmdlet.Unit"> <summary> <para> <para>The unit. The list of valid values is below.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSInstancePortStateListCmdlet"> <summary> Returns the port states for a specific virtual private server, or <i>instance</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstancePortStateListCmdlet.InstanceName"> <summary> <para> <para>The name of the instance.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceSnapshotCmdlet"> <summary> Returns information about a specific instance snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceSnapshotCmdlet.InstanceSnapshotName"> <summary> <para> <para>The name of the snapshot for which you are requesting information.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceSnapshotListCmdlet"> <summary> Returns all instance snapshots for the user's account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceSnapshotListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get instance snapshots request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceStateCmdlet"> <summary> Returns the state of a specific instance. Works on one instance at a time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSInstanceStateCmdlet.InstanceName"> <summary> <para> <para>The name of the instance to get state information about.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSKeyPairInfoCmdlet"> <summary> Returns information about a specific key pair. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSKeyPairInfoCmdlet.KeyPairName"> <summary> <para> <para>The name of the key pair for which you are requesting information.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSKeypairListCmdlet"> <summary> Returns information about all key pairs in the user's account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSKeypairListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get key pairs request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerCmdlet"> <summary> Returns information about the specified Lightsail load balancer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerListCmdlet"> <summary> Returns information about all load balancers in an account. <para> If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerListCmdlet.PageToken"> <summary> <para> <para>A token used for paginating the results from your GetLoadBalancers request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerMetricDataCmdlet"> <summary> Returns information about health metrics for your Lightsail load balancer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerMetricDataCmdlet.EndTime"> <summary> <para> <para>The end time of the period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerMetricDataCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerMetricDataCmdlet.MetricName"> <summary> <para> <para>The metric about which you want to return information. Valid values are listed below, along with the most useful <code>statistics</code> to include in your request.</para><ul><li><para><b><code>ClientTLSNegotiationErrorCount</code></b> - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</para></li><li><para><b><code>HealthyHostCount</code></b> - The number of target instances that are considered healthy.</para><para><code>Statistics</code>: The most useful statistic are <code>Average</code>, <code>Minimum</code>, and <code>Maximum</code>.</para></li><li><para><b><code>UnhealthyHostCount</code></b> - The number of target instances that are considered unhealthy.</para><para><code>Statistics</code>: The most useful statistic are <code>Average</code>, <code>Minimum</code>, and <code>Maximum</code>.</para></li><li><para><b><code>HTTPCode_LB_4XX_Count</code></b> - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</para></li><li><para><b><code>HTTPCode_LB_5XX_Count</code></b> - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</para></li><li><para><b><code>HTTPCode_Instance_2XX_Count</code></b> - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</para></li><li><para><b><code>HTTPCode_Instance_3XX_Count</code></b> - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. </para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</para></li><li><para><b><code>HTTPCode_Instance_4XX_Count</code></b> - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</para></li><li><para><b><code>HTTPCode_Instance_5XX_Count</code></b> - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</para></li><li><para><b><code>InstanceResponseTime</code></b> - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.</para><para><code>Statistics</code>: The most useful statistic is <code>Average</code>.</para></li><li><para><b><code>RejectedConnectionCount</code></b> - The number of connections that were rejected because the load balancer had reached its maximum number of connections.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</para></li><li><para><b><code>RequestCount</code></b> - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.</para><para><code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerMetricDataCmdlet.Period"> <summary> <para> <para>The granularity, in seconds, of the returned data points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerMetricDataCmdlet.StartTime"> <summary> <para> <para>The start time of the period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerMetricDataCmdlet.Statistic"> <summary> <para> <para>An array of statistics that you want to request metrics for. Valid values are listed below.</para><ul><li><para><b><code>SampleCount</code></b> - The count (number) of data points used for the statistical calculation.</para></li><li><para><b><code>Average</code></b> - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.</para></li><li><para><b><code>Sum</code></b> - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.</para></li><li><para><b><code>Minimum</code></b> - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.</para></li><li><para><b><code>Maximum</code></b> - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerMetricDataCmdlet.Unit"> <summary> <para> <para>The unit for the time period request. Valid values are listed below.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerTlsCertificateCmdlet"> <summary> Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. <para> TLS is just an updated, more secure version of Secure Socket Layer (SSL). </para><para> You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSLoadBalancerTlsCertificateCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer you associated with your SSL/TLS certificate.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSOperationCmdlet"> <summary> Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSOperationCmdlet.OperationId"> <summary> <para> <para>A GUID used to identify the operation.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSOperationListCmdlet"> <summary> Returns information about all operations. <para> Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to <code>GetOperations</code> use the maximum (last) <code>statusChangedAt</code> value from the previous request. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSOperationListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get operations request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSOperationListForResourceCmdlet"> <summary> Gets operations for a specific resource (e.g., an instance or a static IP).<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSOperationListForResourceCmdlet.ResourceName"> <summary> <para> <para>The name of the resource for which you are requesting information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSOperationListForResourceCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get operations for resource request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRegionListCmdlet"> <summary> Returns a list of all valid regions for Amazon Lightsail. Use the <code>include availability zones</code> parameter to also return the Availability Zones in a region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRegionListCmdlet.IncludeAvailabilityZone"> <summary> <para> <para>A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., <code>us-east-2a</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRegionListCmdlet.IncludeRelationalDatabaseAvailabilityZone"> <summary> <para> <para>>A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., <code>us-east-2a</code>).</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseCmdlet"> <summary> Returns information about a specific database in Amazon Lightsail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of the database that you are looking up.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseBlueprintCmdlet"> <summary> Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. <para> You can use a blueprint ID to create a new database that runs a specific database engine. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseBlueprintCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results for your <code>get relational database blueprints</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseBundleCmdlet"> <summary> Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database. <para> You can use a bundle ID to create a new database with explicit performance specifications. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseBundleCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results for your <code>get relational database bundles</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseEventCmdlet"> <summary> Returns a list of events for a specific database in Amazon Lightsail.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseEventCmdlet.DurationInMinute"> <summary> <para> <para>The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.</para><para>Default: <code>60</code></para><para>The minimum is 1 and the maximum is 14 days (20160 minutes).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseEventCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of the database from which to get events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseEventCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results from for get relational database events request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseListCmdlet"> <summary> Returns information about all of your databases in Amazon Lightsail.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results for your <code>get relational database</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogEventCmdlet"> <summary> Returns a list of log events for a database in Amazon Lightsail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogEventCmdlet.EndTime"> <summary> <para> <para>The end of the time interval from which to get log events.</para><para>Constraints:</para><ul><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Specified in the Unix time format.</para><para>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogEventCmdlet.LogStreamName"> <summary> <para> <para>The name of the log stream.</para><para>Use the <code>get relational database log streams</code> operation to get a list of available log streams.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogEventCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database for which to get log events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogEventCmdlet.StartFromHead"> <summary> <para> <para>Parameter to specify if the log should start from head or tail. If <code>true</code> is specified, the log event starts from the head of the log. If <code>false</code> is specified, the log event starts from the tail of the log.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogEventCmdlet.StartTime"> <summary> <para> <para>The start of the time interval from which to get log events.</para><para>Constraints:</para><ul><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Specified in the Unix time format.</para><para>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogEventCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results for your <code>get relational database log events</code> request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogStreamCmdlet"> <summary> Returns a list of available log streams for a specific database in Amazon Lightsail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseLogStreamCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database for which to get log streams.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMasterUserPasswordCmdlet"> <summary> Returns the current, previous, or pending versions of the master user password for a Lightsail database. <para> The <code>asdf</code> operation GetRelationalDatabaseMasterUserPassword supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMasterUserPasswordCmdlet.PasswordVersion"> <summary> <para> <para>The password version to return.</para><para>Specifying <code>CURRENT</code> or <code>PREVIOUS</code> returns the current or previous passwords respectively. Specifying <code>PENDING</code> returns the newest version of the password that will rotate to <code>CURRENT</code>. After the <code>PENDING</code> password rotates to <code>CURRENT</code>, the <code>PENDING</code> password is no longer available.</para><para>Default: <code>CURRENT</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMasterUserPasswordCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database for which to get the master user password.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMetricDataCmdlet"> <summary> Returns the data points of the specified metric for a database in Amazon Lightsail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMetricDataCmdlet.EndTime"> <summary> <para> <para>The end of the time interval from which to get metric data.</para><para>Constraints:</para><ul><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Specified in the Unix time format.</para><para>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMetricDataCmdlet.MetricName"> <summary> <para> <para>The name of the metric data to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMetricDataCmdlet.Period"> <summary> <para> <para>The granularity, in seconds, of the returned data points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMetricDataCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database from which to get metric data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMetricDataCmdlet.StartTime"> <summary> <para> <para>The start of the time interval from which to get metric data.</para><para>Constraints:</para><ul><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Specified in the Unix time format.</para><para>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMetricDataCmdlet.Statistic"> <summary> <para> <para>The array of statistics for your metric data request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseMetricDataCmdlet.Unit"> <summary> <para> <para>The unit for the metric data request.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseParameterCmdlet"> <summary> Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. <para> In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseParameterCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database for which to get parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseParameterCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results for your <code>get relational database parameters</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseSnapshotCmdlet"> <summary> Returns information about a specific database snapshot in Amazon Lightsail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseSnapshotCmdlet.RelationalDatabaseSnapshotName"> <summary> <para> <para>The name of the database snapshot for which to get information.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseSnapshotListCmdlet"> <summary> Returns information about all of your database snapshots in Amazon Lightsail.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSRelationalDatabaseSnapshotListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to a specific page of results for your <code>get relational database snapshots</code> request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSStaticIpCmdlet"> <summary> Returns information about a specific static IP. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSStaticIpCmdlet.StaticIpName"> <summary> <para> <para>The name of the static IP in Lightsail.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.GetLSStaticIpListCmdlet"> <summary> Returns information about all static IPs in the user's account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.GetLSStaticIpListCmdlet.PageToken"> <summary> <para> <para>A token used for advancing to the next page of results from your get static IPs request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.ImportLSKeyPairCmdlet"> <summary> Imports a public SSH key from a specific key pair. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.ImportLSKeyPairCmdlet.KeyPairName"> <summary> <para> <para>The name of the key pair for which you want to import the public key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.ImportLSKeyPairCmdlet.PublicKeyBase64"> <summary> <para> <para>A base64-encoded public key of the <code>ssh-rsa</code> type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.ImportLSKeyPairCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.MountLSStaticIpCmdlet"> <summary> Attaches a static IP address to a specific Amazon Lightsail instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.MountLSStaticIpCmdlet.InstanceName"> <summary> <para> <para>The instance name to which you want to attach the static IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.MountLSStaticIpCmdlet.StaticIpName"> <summary> <para> <para>The name of the static IP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.MountLSStaticIpCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSCloudFormationStackCmdlet"> <summary> Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the <code>get cloud formation stack records</code> operation to get a list of the CloudFormation stacks created. <important><para> Wait until after your new Amazon EC2 instance is created before running the <code>create cloud formation stack</code> operation again with the same export snapshot record. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSCloudFormationStackCmdlet.Instance"> <summary> <para> <para>An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSCloudFormationStackCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSDiskCmdlet"> <summary> Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see <a href="https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail">Regions and Availability Zones in Lightsail</a>. <para> The <code>create disk</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone where you want to create the disk (e.g., <code>us-east-2a</code>). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.</para><para>Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskCmdlet.DiskName"> <summary> <para> <para>The unique Lightsail disk name (e.g., <code>my-disk</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskCmdlet.SizeInGb"> <summary> <para> <para>The size of the disk in GB (e.g., <code>32</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSDiskFromSnapshotCmdlet"> <summary> Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see <a href="https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail">Regions and Availability Zones in Lightsail</a>. <para> The <code>create disk from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskFromSnapshotCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone where you want to create the disk (e.g., <code>us-east-2a</code>). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.</para><para>Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskFromSnapshotCmdlet.DiskName"> <summary> <para> <para>The unique Lightsail disk name (e.g., <code>my-disk</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskFromSnapshotCmdlet.DiskSnapshotName"> <summary> <para> <para>The name of the disk snapshot (e.g., <code>my-snapshot</code>) from which to create the new storage disk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskFromSnapshotCmdlet.SizeInGb"> <summary> <para> <para>The size of the disk in GB (e.g., <code>32</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskFromSnapshotCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskFromSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSDiskSnapshotCmdlet"> <summary> Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. <para> You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk 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 disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending. </para><para> You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the <code>instance name</code> parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk. </para><para> The <code>create disk snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskSnapshotCmdlet.DiskName"> <summary> <para> <para>The unique name of the source disk (e.g., <code>Disk-Virginia-1</code>).</para><note><para>This parameter cannot be defined together with the <code>instance name</code> parameter. The <code>disk name</code> and <code>instance name</code> parameters are mutually exclusive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskSnapshotCmdlet.DiskSnapshotName"> <summary> <para> <para>The name of the destination disk snapshot (e.g., <code>my-disk-snapshot</code>) based on the source disk.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskSnapshotCmdlet.InstanceName"> <summary> <para> <para>The unique name of the source instance (e.g., <code>Amazon_Linux-512MB-Virginia-1</code>). When this is defined, a snapshot of the instance's system volume is created.</para><note><para>This parameter cannot be defined together with the <code>disk name</code> parameter. The <code>instance name</code> and <code>disk name</code> parameters are mutually exclusive.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskSnapshotCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDiskSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSDomainCmdlet"> <summary> Creates a domain resource for the specified domain (e.g., example.com). <para> The <code>create domain</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainCmdlet.DomainName"> <summary> <para> <para>The domain name to manage (e.g., <code>example.com</code>).</para><note><para>You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet"> <summary> Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). <para> The <code>create domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet.DomainName"> <summary> <para> <para>The domain name (e.g., <code>example.com</code>) for which you want to create the domain entry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet.DomainEntry_Id"> <summary> <para> <para>The ID of the domain recordset entry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet.DomainEntry_IsAlias"> <summary> <para> <para>When <code>true</code>, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet.DomainEntry_Name"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet.DomainEntry_Target"> <summary> <para> <para>The target AWS name server (e.g., <code>ns-111.awsdns-22.com.</code>).</para><para>For Lightsail load balancers, the value looks like <code>ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com</code>. Be sure to also set <code>isAlias</code> to <code>true</code> when setting up an A record for a load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet.DomainEntry_Type"> <summary> <para> <para>The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).</para><para>The following domain entry types can be used:</para><ul><li><para><code>A</code></para></li><li><para><code>CNAME</code></para></li><li><para><code>MX</code></para></li><li><para><code>NS</code></para></li><li><para><code>SOA</code></para></li><li><para><code>SRV</code></para></li><li><para><code>TXT</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet.DomainEntry_Option"> <summary> <para> <para>(Deprecated) The options for the domain entry.</para><note><para>In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.</para></note> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSDomainEntryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet"> <summary> Creates one or more Amazon Lightsail virtual private servers, or <i>instances</i>. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints. <para> The <code>create instances</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone in which to create your instance. Use the following format: <code>us-east-2a</code> (case sensitive). You can get a list of Availability Zones by using the <a href="http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html">get regions</a> operation. Be sure to add the <code>include Availability Zones</code> parameter to your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.BlueprintId"> <summary> <para> <para>The ID for a virtual private server image (e.g., <code>app_wordpress_4_4</code> or <code>app_lamp_7_0</code>). Use the get blueprints operation to return a list of available images (or <i>blueprints</i>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.BundleId"> <summary> <para> <para>The bundle of specification information for your virtual private server (or <i>instance</i>), including the pricing plan (e.g., <code>micro_1_0</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.InstanceName"> <summary> <para> <para>The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: <code>["MyFirstInstance","MySecondInstance"]</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.KeyPairName"> <summary> <para> <para>The name of your key pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.UserData"> <summary> <para> <para>A launch script you can create that configures a server with additional user data. For example, you might want to run <code>apt-get -y update</code>.</para><note><para>Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use <code>yum</code>, Debian and Ubuntu use <code>apt-get</code>, and FreeBSD uses <code>pkg</code>. For a complete list, see the <a href="https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image">Dev Guide</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.CustomImageName"> <summary> <para> <para>(Deprecated) The name for your custom image.</para><note><para>In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.</para></note> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet"> <summary> Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration. <para> The <code>create instances from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.AttachedDiskMapping"> <summary> <para> <para>An object containing information about one or more disk mappings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone where you want to create your instances. Use the following formatting: <code>us-east-2a</code> (case sensitive). You can get a list of Availability Zones by using the <a href="http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html">get regions</a> operation. Be sure to add the <code>include Availability Zones</code> parameter to your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.BundleId"> <summary> <para> <para>The bundle of specification information for your virtual private server (or <i>instance</i>), including the pricing plan (e.g., <code>micro_1_0</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.InstanceName"> <summary> <para> <para>The names for your new instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.InstanceSnapshotName"> <summary> <para> <para>The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.KeyPairName"> <summary> <para> <para>The name for your key pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.UserData"> <summary> <para> <para>You can create a launch script that configures a server with additional user data. For example, <code>apt-get -y update</code>.</para><note><para>Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use <code>yum</code>, Debian and Ubuntu use <code>apt-get</code>, and FreeBSD uses <code>pkg</code>. For a complete list, see the <a href="https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image">Dev Guide</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstancesFromSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceSnapshotCmdlet"> <summary> Creates a snapshot of a specific virtual private server, or <i>instance</i>. You can use a snapshot to create a new instance that is based on that snapshot. <para> The <code>create instance snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceSnapshotCmdlet.InstanceName"> <summary> <para> <para>The Lightsail instance on which to base your snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceSnapshotCmdlet.InstanceSnapshotName"> <summary> <para> <para>The name for your new snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceSnapshotCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSInstanceSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSKeyPairCmdlet"> <summary> Creates an SSH key pair. <para> The <code>create key pair</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSKeyPairCmdlet.KeyPairName"> <summary> <para> <para>The name for your new key pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSKeyPairCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSKeyPairCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet"> <summary> Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see <a href="https://lightsail.aws.amazon.com/ls/docs/how-to/article/configure-lightsail-instances-for-load-balancing">Configure your Lightsail instances for load balancing</a>. You can create up to 5 load balancers per AWS Region in your account. <para> When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the <code>UpdateLoadBalancerAttribute</code> operation. </para><para> The <code>create load balancer</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet.CertificateAlternativeName"> <summary> <para> <para>The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., <code>www.example.com</code>, <code>example.com</code>, <code>m.example.com</code>, <code>blog.example.com</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet.CertificateDomainName"> <summary> <para> <para>The domain name with which your certificate is associated (e.g., <code>example.com</code>).</para><para>If you specify <code>certificateDomainName</code>, then <code>certificateName</code> is required (and vice-versa).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet.CertificateName"> <summary> <para> <para>The name of the SSL/TLS certificate.</para><para>If you specify <code>certificateName</code>, then <code>certificateDomainName</code> is required (and vice-versa).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet.HealthCheckPath"> <summary> <para> <para>The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., <code>"/"</code>).</para><para>You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet.InstancePort"> <summary> <para> <para>The instance port where you're creating your load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of your load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerTlsCertificateCmdlet"> <summary> Creates a Lightsail load balancer TLS certificate. <para> TLS is just an updated, more secure version of Secure Socket Layer (SSL). </para><para> The <code>create load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerTlsCertificateCmdlet.CertificateAlternativeName"> <summary> <para> <para>An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., <code>*.example.com</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerTlsCertificateCmdlet.CertificateDomainName"> <summary> <para> <para>The domain name (e.g., <code>example.com</code>) for your SSL/TLS certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerTlsCertificateCmdlet.CertificateName"> <summary> <para> <para>The SSL/TLS certificate name.</para><para>You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see <a href="http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html">Limits</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerTlsCertificateCmdlet.LoadBalancerName"> <summary> <para> <para>The load balancer name where you want to create the SSL/TLS certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerTlsCertificateCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSLoadBalancerTlsCertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet"> <summary> Creates a new database in Amazon Lightsail. <para> The <code>create relational database</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone in which to create your new database. Use the <code>us-east-2a</code> case-sensitive format.</para><para>You can get a list of Availability Zones by using the <code>get regions</code> operation. Be sure to add the <code>include relational database Availability Zones</code> parameter to your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.MasterDatabaseName"> <summary> <para> <para>The name of the master database created when the Lightsail database resource is created.</para><para>Constraints:</para><ul><li><para>Must contain from 1 to 64 alphanumeric characters.</para></li><li><para>Cannot be a word reserved by the specified database engine</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.MasterUsername"> <summary> <para> <para>The master user name for your new database.</para><para>Constraints:</para><ul><li><para>Master user name is required.</para></li><li><para>Must contain from 1 to 16 alphanumeric characters.</para></li><li><para>The first character must be a letter.</para></li><li><para>Cannot be a reserved word for the database engine you choose.</para><para>For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for <a href="https://dev.mysql.com/doc/refman/5.6/en/keywords.html">MySQL 5.6</a> or <a href="https://dev.mysql.com/doc/refman/5.7/en/keywords.html">MySQL 5.7</a> respectively.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.MasterUserPassword"> <summary> <para> <para>The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@".</para><para>Constraints: Must contain 8 to 41 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.PreferredBackupWindow"> <summary> <para> <para>The daily time range during which automated backups are created for your new database if automated backups are enabled.</para><para>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow">Working With Backups</a> guide in the Amazon Relational Database Service (Amazon RDS) documentation.</para><para>Constraints:</para><ul><li><para>Must be in the <code>hh24:mi-hh24:mi</code> format.</para><para>Example: <code>16:00-16:30</code></para></li><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Must not conflict with the preferred maintenance window.</para></li><li><para>Must be at least 30 minutes.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>The weekly time range during which system maintenance can occur on your new database.</para><para>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.</para><para>Constraints:</para><ul><li><para>Must be in the <code>ddd:hh24:mi-ddd:hh24:mi</code> format.</para></li><li><para>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</para></li><li><para>Must be at least 30 minutes.</para></li><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Example: <code>Tue:17:00-Tue:17:30</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.PubliclyAccessible"> <summary> <para> <para>Specifies the accessibility options for your new database. A value of <code>true</code> specifies a database that is available to resources outside of your Lightsail account. A value of <code>false</code> specifies a database that is available only to your Lightsail resources in the same region as your database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.RelationalDatabaseBlueprintId"> <summary> <para> <para>The blueprint ID for your new database. A blueprint describes the major engine version of a database.</para><para>You can get a list of database blueprints IDs by using the <code>get relational database blueprints</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.RelationalDatabaseBundleId"> <summary> <para> <para>The bundle ID for your new database. A bundle describes the performance specifications for your database.</para><para>You can get a list of database bundle IDs by using the <code>get relational database bundles</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name to use for your new database.</para><para>Constraints:</para><ul><li><para>Must contain from 2 to 255 alphanumeric characters, or hyphens.</para></li><li><para>The first and last character must be a letter or number.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet"> <summary> Creates a new database from an existing database snapshot in Amazon Lightsail. <para> You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan. </para><para> The <code>create relational database from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone in which to create your new database. Use the <code>us-east-2a</code> case-sensitive format.</para><para>You can get a list of Availability Zones by using the <code>get regions</code> operation. Be sure to add the <code>include relational database Availability Zones</code> parameter to your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.PubliclyAccessible"> <summary> <para> <para>Specifies the accessibility options for your new database. A value of <code>true</code> specifies a database that is available to resources outside of your Lightsail account. A value of <code>false</code> specifies a database that is available only to your Lightsail resources in the same region as your database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.RelationalDatabaseBundleId"> <summary> <para> <para>The bundle ID for your new database. A bundle describes the performance specifications for your database.</para><para>You can get a list of database bundle IDs by using the <code>get relational database bundles</code> operation.</para><para>When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name to use for your new database.</para><para>Constraints:</para><ul><li><para>Must contain from 2 to 255 alphanumeric characters, or hyphens.</para></li><li><para>The first and last character must be a letter or number.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.RelationalDatabaseSnapshotName"> <summary> <para> <para>The name of the database snapshot from which to create your new database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.RestoreTime"> <summary> <para> <para>The date and time to restore your database from.</para><para>Constraints:</para><ul><li><para>Must be before the latest restorable time for the database.</para></li><li><para>Cannot be specified if the <code>use latest restorable time</code> parameter is <code>true</code>.</para></li><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Specified in the Unix time format.</para><para>For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the restore time.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.SourceRelationalDatabaseName"> <summary> <para> <para>The name of the source database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.UseLatestRestorableTime"> <summary> <para> <para>Specifies whether your database is restored from the latest backup time. A value of <code>true</code> restores from the latest backup time. </para><para>Default: <code>false</code></para><para>Constraints: Cannot be specified if the <code>restore time</code> parameter is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseFromSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseSnapshotCmdlet"> <summary> Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. <para> The <code>create relational database snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseSnapshotCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of the database on which to base your new snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseSnapshotCmdlet.RelationalDatabaseSnapshotName"> <summary> <para> <para>The name for your new database snapshot.</para><para>Constraints:</para><ul><li><para>Must contain from 2 to 255 alphanumeric characters, or hyphens.</para></li><li><para>The first and last character must be a letter or number.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseSnapshotCmdlet.Tag"> <summary> <para> <para>The tag keys and optional values to add to the resource during create.</para><para>To tag a resource after it has been created, see the <code>tag resource</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSRelationalDatabaseSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.NewLSStaticIpCmdlet"> <summary> Allocates a static IP address. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSStaticIpCmdlet.StaticIpName"> <summary> <para> <para>The name of the static IP address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.NewLSStaticIpCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.OpenLSInstancePublicPortCmdlet"> <summary> Adds public ports to an Amazon Lightsail instance. <para> The <code>open instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.OpenLSInstancePublicPortCmdlet.PortInfo_FromPort"> <summary> <para> <para>The first port in the range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.OpenLSInstancePublicPortCmdlet.InstanceName"> <summary> <para> <para>The name of the instance for which you want to open the public ports.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.OpenLSInstancePublicPortCmdlet.PortInfo_Protocol"> <summary> <para> <para>The protocol. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.OpenLSInstancePublicPortCmdlet.PortInfo_ToPort"> <summary> <para> <para>The last port in the range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.OpenLSInstancePublicPortCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.ReadLSDefaultKeyPairCmdlet"> <summary> Downloads the default SSH key pair from the user's account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.ReadLSDefaultKeyPairCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSDiskCmdlet"> <summary> Deletes the specified block storage disk. The disk must be in the <code>available</code> state (not attached to a Lightsail instance). <note><para> The disk may remain in the <code>deleting</code> state for several minutes. </para></note><para> The <code>delete disk</code> operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDiskCmdlet.DiskName"> <summary> <para> <para>The unique name of the disk you want to delete (e.g., <code>my-disk</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDiskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSDiskSnapshotCmdlet"> <summary> Deletes the specified disk snapshot. <para> When you make periodic snapshots of a disk, 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 disk. </para><para> The <code>delete disk snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by diskSnapshotName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDiskSnapshotCmdlet.DiskSnapshotName"> <summary> <para> <para>The name of the disk snapshot you want to delete (e.g., <code>my-disk-snapshot</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDiskSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainCmdlet"> <summary> Deletes the specified domain recordset and all of its domain records. <para> The <code>delete domain</code> operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainCmdlet.DomainName"> <summary> <para> <para>The specific domain name to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet"> <summary> Deletes a specific domain entry. <para> The <code>delete domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet.DomainName"> <summary> <para> <para>The name of the domain entry to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet.DomainEntry_Id"> <summary> <para> <para>The ID of the domain recordset entry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet.DomainEntry_IsAlias"> <summary> <para> <para>When <code>true</code>, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet.DomainEntry_Name"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet.DomainEntry_Target"> <summary> <para> <para>The target AWS name server (e.g., <code>ns-111.awsdns-22.com.</code>).</para><para>For Lightsail load balancers, the value looks like <code>ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com</code>. Be sure to also set <code>isAlias</code> to <code>true</code> when setting up an A record for a load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet.DomainEntry_Type"> <summary> <para> <para>The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).</para><para>The following domain entry types can be used:</para><ul><li><para><code>A</code></para></li><li><para><code>CNAME</code></para></li><li><para><code>MX</code></para></li><li><para><code>NS</code></para></li><li><para><code>SOA</code></para></li><li><para><code>SRV</code></para></li><li><para><code>TXT</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet.DomainEntry_Option"> <summary> <para> <para>(Deprecated) The options for the domain entry.</para><note><para>In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.</para></note> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSDomainEntryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSInstanceCmdlet"> <summary> Deletes a specific Amazon Lightsail virtual private server, or <i>instance</i>. <para> The <code>delete instance</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSInstanceCmdlet.InstanceName"> <summary> <para> <para>The name of the instance to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSInstanceSnapshotCmdlet"> <summary> Deletes a specific snapshot of a virtual private server (or <i>instance</i>). <para> The <code>delete instance snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceSnapshotName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSInstanceSnapshotCmdlet.InstanceSnapshotName"> <summary> <para> <para>The name of the snapshot to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSInstanceSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSKeyPairCmdlet"> <summary> Deletes a specific SSH key pair. <para> The <code>delete key pair</code> operation supports tag-based access control via resource tags applied to the resource identified by keyPairName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSKeyPairCmdlet.KeyPairName"> <summary> <para> <para>The name of the key pair to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSKeyPairCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSKnownHostKeyCmdlet"> <summary> Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch. <important><para> Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection">Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client</a>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSKnownHostKeyCmdlet.InstanceName"> <summary> <para> <para>The name of the instance for which you want to reset the host key or certificate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSKnownHostKeyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSLoadBalancerCmdlet"> <summary> Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again. <para> The <code>delete load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSLoadBalancerCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSLoadBalancerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSLoadBalancerTlsCertificateCmdlet"> <summary> Deletes an SSL/TLS certificate associated with a Lightsail load balancer. <para> The <code>delete load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSLoadBalancerTlsCertificateCmdlet.CertificateName"> <summary> <para> <para>The SSL/TLS certificate name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSLoadBalancerTlsCertificateCmdlet.DeleteWithForce"> <summary> <para> <para>When <code>true</code>, forces the deletion of an SSL/TLS certificate.</para><para>There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The <code>force</code> parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSLoadBalancerTlsCertificateCmdlet.LoadBalancerName"> <summary> <para> <para>The load balancer name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSLoadBalancerTlsCertificateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSPeerVpcCmdlet"> <summary> Attempts to unpeer the Lightsail VPC from the user's default VPC. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSPeerVpcCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSRelationalDatabaseCmdlet"> <summary> Deletes a database in Amazon Lightsail. <para> The <code>delete relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSRelationalDatabaseCmdlet.FinalRelationalDatabaseSnapshotName"> <summary> <para> <para>The name of the database snapshot created if <code>skip final snapshot</code> is <code>false</code>, which is the default value for that parameter.</para><note><para>Specifying this parameter and also specifying the <code>skip final snapshot</code> parameter to <code>true</code> results in an error.</para></note><para>Constraints:</para><ul><li><para>Must contain from 2 to 255 alphanumeric characters, or hyphens.</para></li><li><para>The first and last character must be a letter or number.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSRelationalDatabaseCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of the database that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSRelationalDatabaseCmdlet.SkipFinalSnapshot"> <summary> <para> <para>Determines whether a final database snapshot is created before your database is deleted. If <code>true</code> is specified, no database snapshot is created. If <code>false</code> is specified, a database snapshot is created before your database is deleted.</para><para>You must specify the <code>final relational database snapshot name</code> parameter if the <code>skip final snapshot</code> parameter is <code>false</code>.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSRelationalDatabaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSRelationalDatabaseSnapshotCmdlet"> <summary> Deletes a database snapshot in Amazon Lightsail. <para> The <code>delete relational database snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSRelationalDatabaseSnapshotCmdlet.RelationalDatabaseSnapshotName"> <summary> <para> <para>The name of the database snapshot that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSRelationalDatabaseSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSResourceTagCmdlet"> <summary> Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. <para> The <code>untag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSResourceTagCmdlet.ResourceName"> <summary> <para> <para>The name of the resource from which you are removing a tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys to delete from the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RemoveLSStaticIpCmdlet"> <summary> Deletes a specific static IP from your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSStaticIpCmdlet.StaticIpName"> <summary> <para> <para>The name of the static IP to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RemoveLSStaticIpCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RestartLSInstanceCmdlet"> <summary> Restarts a specific instance. <para> The <code>reboot instance</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RestartLSInstanceCmdlet.InstanceName"> <summary> <para> <para>The name of the instance to reboot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RestartLSInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.RestartLSRelationalDatabaseCmdlet"> <summary> Restarts a specific database in Amazon Lightsail. <para> The <code>reboot relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RestartLSRelationalDatabaseCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database to reboot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.RestartLSRelationalDatabaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.SetLSInstancePublicPortCmdlet"> <summary> Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request. <para> The <code>put instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.SetLSInstancePublicPortCmdlet.InstanceName"> <summary> <para> <para>The Lightsail instance name of the public port(s) you are setting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.SetLSInstancePublicPortCmdlet.PortInfo"> <summary> <para> <para>Specifies information about the public port(s).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.SetLSInstancePublicPortCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.StartLSInstanceCmdlet"> <summary> Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the <code>reboot instance</code> operation. <note><para> When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip">Lightsail Dev Guide</a>. </para></note><para> The <code>start instance</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StartLSInstanceCmdlet.InstanceName"> <summary> <para> <para>The name of the instance (a virtual private server) to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StartLSInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.StartLSRelationalDatabaseCmdlet"> <summary> Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the <code>reboot relational database</code> operation. <para> The <code>start relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StartLSRelationalDatabaseCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StartLSRelationalDatabaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.StopLSInstanceCmdlet"> <summary> Stops a specific Amazon Lightsail instance that is currently running. <note><para> When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip">Lightsail Dev Guide</a>. </para></note><para> The <code>stop instance</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StopLSInstanceCmdlet.OverrideStuck"> <summary> <para> <para>When set to <code>True</code>, forces a Lightsail instance that is stuck in a <code>stopping</code> state to stop.</para><important><para>Only use the <code>force</code> parameter if your instance is stuck in the <code>stopping</code> state. In any other state, your instance should stop normally without adding this parameter to your API request.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StopLSInstanceCmdlet.InstanceName"> <summary> <para> <para>The name of the instance (a virtual private server) to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StopLSInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.StopLSRelationalDatabaseCmdlet"> <summary> Stops a specific database that is currently running in Amazon Lightsail. <para> The <code>stop relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StopLSRelationalDatabaseCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StopLSRelationalDatabaseCmdlet.RelationalDatabaseSnapshotName"> <summary> <para> <para>The name of your new database snapshot to be created before stopping your database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.StopLSRelationalDatabaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.TestLSVpcPeeredCmdlet"> <summary> Returns a Boolean value indicating whether your Lightsail VPC is peered. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet"> <summary> Updates a domain recordset after it is created. <para> The <code>update domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet.DomainName"> <summary> <para> <para>The name of the domain recordset to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet.DomainEntry_Id"> <summary> <para> <para>The ID of the domain recordset entry.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet.DomainEntry_IsAlias"> <summary> <para> <para>When <code>true</code>, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet.DomainEntry_Name"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet.DomainEntry_Target"> <summary> <para> <para>The target AWS name server (e.g., <code>ns-111.awsdns-22.com.</code>).</para><para>For Lightsail load balancers, the value looks like <code>ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com</code>. Be sure to also set <code>isAlias</code> to <code>true</code> when setting up an A record for a load balancer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet.DomainEntry_Type"> <summary> <para> <para>The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).</para><para>The following domain entry types can be used:</para><ul><li><para><code>A</code></para></li><li><para><code>CNAME</code></para></li><li><para><code>MX</code></para></li><li><para><code>NS</code></para></li><li><para><code>SOA</code></para></li><li><para><code>SRV</code></para></li><li><para><code>TXT</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet.DomainEntry_Option"> <summary> <para> <para>(Deprecated) The options for the domain entry.</para><note><para>In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.</para></note> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSDomainEntryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.UpdateLSLoadBalancerAttributeCmdlet"> <summary> Updates the specified attribute for a load balancer. You can only update one attribute at a time. <para> The <code>update load balancer attribute</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSLoadBalancerAttributeCmdlet.AttributeName"> <summary> <para> <para>The name of the attribute you want to update. Valid values are below.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSLoadBalancerAttributeCmdlet.AttributeValue"> <summary> <para> <para>The value that you want to specify for the attribute name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSLoadBalancerAttributeCmdlet.LoadBalancerName"> <summary> <para> <para>The name of the load balancer that you want to modify (e.g., <code>my-load-balancer</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSLoadBalancerAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet"> <summary> Allows the update of one or more attributes of a database in Amazon Lightsail. <para> Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. </para><para> The <code>update relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.ApplyImmediately"> <summary> <para> <para>When <code>true</code>, applies changes immediately. When <code>false</code>, applies changes during the preferred maintenance window. Some changes may cause an outage.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.DisableBackupRetention"> <summary> <para> <para>When <code>true</code>, disables automated backup retention for your database.</para><para>Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the <code>create relational database snapshot</code> operation.</para><para>Updates are applied during the next maintenance window because this can result in an outage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.EnableBackupRetention"> <summary> <para> <para>When <code>true</code>, enables automated backup retention for your database.</para><para>Updates are applied during the next maintenance window because this can result in an outage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.MasterUserPassword"> <summary> <para> <para>The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".</para><para>Constraints: Must contain 8 to 41 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.PreferredBackupWindow"> <summary> <para> <para>The daily time range during which automated backups are created for your database if automated backups are enabled.</para><para>Constraints:</para><ul><li><para>Must be in the <code>hh24:mi-hh24:mi</code> format.</para><para>Example: <code>16:00-16:30</code></para></li><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Must not conflict with the preferred maintenance window.</para></li><li><para>Must be at least 30 minutes.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>The weekly time range during which system maintenance can occur on your database.</para><para>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.</para><para>Constraints:</para><ul><li><para>Must be in the <code>ddd:hh24:mi-ddd:hh24:mi</code> format.</para></li><li><para>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</para></li><li><para>Must be at least 30 minutes.</para></li><li><para>Specified in Universal Coordinated Time (UTC).</para></li><li><para>Example: <code>Tue:17:00-Tue:17:30</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.PubliclyAccessible"> <summary> <para> <para>Specifies the accessibility options for your database. A value of <code>true</code> specifies a database that is available to resources outside of your Lightsail account. A value of <code>false</code> specifies a database that is available only to your Lightsail resources in the same region as your database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.RotateMasterUserPassword"> <summary> <para> <para>When <code>true</code>, the master user password is changed to a new strong password generated by Lightsail.</para><para>Use the <code>get relational database master user password</code> operation to get the new password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseParameterCmdlet"> <summary> Allows the update of one or more parameters of a database in Amazon Lightsail. <para> Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which paramater updates are applied: <code>dynamic</code> or <code>pending-reboot</code>. Parameters marked with a <code>dynamic</code> apply type are applied immediately. Parameters marked with a <code>pending-reboot</code> apply type are applied only after the database is rebooted using the <code>reboot relational database</code> operation. </para><para> The <code>update relational database parameters</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags">Lightsail Dev Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseParameterCmdlet.Parameter"> <summary> <para> <para>The database parameters to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseParameterCmdlet.RelationalDatabaseName"> <summary> <para> <para>The name of your database for which to update parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LS.UpdateLSRelationalDatabaseParameterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |