aws lightsail161 CLI commands available for Amazon Lightsail.
| Command | API Operation | Sample |
|---|---|---|
allocate-static-ipAllocates a static IP address. | AllocateStaticIp | |
attach-certificate-to-distributionAttaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate. Use the CreateCertificate action to create a certificate t | AttachCertificateToDistribution | |
attach-diskAttaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name. The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Li | AttachDisk | |
attach-instances-to-load-balancerAttaches one or more Lightsail instances to a load balancer. After some time, the instances are attached to the load balancer and the health check status is available. The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identifi | AttachInstancesToLoadBalancer | |
attach-load-balancer-tls-certificateAttaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). 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 | AttachLoadBalancerTlsCertificate | |
attach-static-ipAttaches a static IP address to a specific Amazon Lightsail instance. | AttachStaticIp | |
close-instance-public-portsCloses ports for a specific Amazon Lightsail instance. The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide. | CloseInstancePublicPorts | |
copy-snapshotCopies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in A | CopySnapshot | |
create-bucketCreates an Amazon Lightsail bucket. A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Gu | CreateBucket | |
create-bucket-access-keyCreates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key. Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucket | CreateBucketAccessKey | |
create-certificateCreates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service. After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService | CreateCertificate | |
create-cloud-formation-stackCreates 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 get cloud formation stack records operation to get | CreateCloudFormationStack | |
create-contact-methodCreates an email or SMS text message contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in | CreateContactMethod | |
create-container-serviceCreates an Amazon Lightsail container service. A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide. | CreateContainerService | |
create-container-service-deploymentCreates a deployment for your Amazon Lightsail container service. A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container tha | CreateContainerServiceDeployment | |
create-container-service-registry-loginCreates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can us | CreateContainerServiceRegistryLogin | |
create-diskCreates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a). The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. | CreateDisk | |
create-disk-from-snapshotCreates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a). The create disk from snapshot operation supports tag-based access control via request tags and resource tags appl | CreateDiskFromSnapshot | |
create-disk-snapshotCreates 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. 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 t | CreateDiskSnapshot | |
create-distributionCreates an Amazon Lightsail content delivery network (CDN) distribution. A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon L | CreateDistribution | |
create-domainCreates a domain resource for the specified domain (example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. | CreateDomain | |
create-domain-entryCreates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via reso | CreateDomainEntry | |
create-gui-session-access-detailsCreates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session | CreateGUISessionAccessDetails | |
create-instance-snapshotCreates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot. The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Gu | CreateInstanceSnapshot | |
create-instancesCreates one or more Amazon Lightsail instances. The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide. | CreateInstances | |
create-instances-from-snapshotCreates one or more new instances from a manual or automatic snapshot of an instance. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon L | CreateInstancesFromSnapshot | |
create-key-pairCreates a custom SSH key pair that you can use with an Amazon Lightsail instance. Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist. The create key pair operation supports tag-based access | CreateKeyPair | |
create-load-balancerCreates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 10 load balancers per AWS Region in your account. When you create a load balancer, you can specify a unique name a | CreateLoadBalancer | |
create-load-balancer-tls-certificateCreates an SSL/TLS certificate for an Amazon Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. | CreateLoadBalancerTlsCertificate | |
create-relational-databaseCreates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. | CreateRelationalDatabase | |
create-relational-database-from-snapshotCreates a new database from an existing database snapshot in Amazon Lightsail. 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. The create relational database from | CreateRelationalDatabaseFromSnapshot | |
create-relational-database-snapshotCreates 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. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the A | CreateRelationalDatabaseSnapshot | |
delete-alarmDeletes an alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. | DeleteAlarm | |
delete-auto-snapshotDeletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide. | DeleteAutoSnapshot | |
delete-bucketDeletes a Amazon Lightsail bucket. When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account. | DeleteBucket | |
delete-bucket-access-keyDeletes an access key for the specified Amazon Lightsail bucket. We recommend that you delete an access key if the secret access key is compromised. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. | DeleteBucketAccessKey | |
delete-certificateDeletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution. Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution. | DeleteCertificate | |
delete-contact-methodDeletes a contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Re | DeleteContactMethod | |
delete-container-imageDeletes a container image that is registered to your Amazon Lightsail container service. | DeleteContainerImage | |
delete-container-serviceDeletes your Amazon Lightsail container service. | DeleteContainerService | |
delete-diskDeletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identified | DeleteDisk | |
delete-disk-snapshotDeletes the specified disk snapshot. 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 r | DeleteDiskSnapshot | |
delete-distributionDeletes your Amazon Lightsail content delivery network (CDN) distribution. | DeleteDistribution | |
delete-domainDeletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide. | DeleteDomain | |
delete-domain-entryDeletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide. | DeleteDomainEntry | |
delete-instanceDeletes an Amazon Lightsail instance. The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide. | DeleteInstance | |
delete-instance-snapshotDeletes a specific snapshot of a virtual private server (or instance). The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide. | DeleteInstanceSnapshot | |
delete-key-pairDeletes the specified key pair by removing the public key from Amazon Lightsail. You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without s | DeleteKeyPair | |
delete-known-host-keysDeletes 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. Perform this operation only if you were ex | DeleteKnownHostKeys | |
delete-load-balancerDeletes 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. The delete load balancer operation supports tag-based access control via resourc | DeleteLoadBalancer | |
delete-load-balancer-tls-certificateDeletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide. | DeleteLoadBalancerTlsCertificate | |
delete-relational-databaseDeletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. | DeleteRelationalDatabase | |
delete-relational-database-snapshotDeletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. | DeleteRelationalDatabaseSnapshot | |
detach-certificate-from-distributionDetaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate. | DetachCertificateFromDistribution | |
detach-diskDetaches 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. The detach disk operation supports tag-based access control via resource tags applied to the resource | DetachDisk | |
detach-instances-from-load-balancerDetaches the specified instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from the load balancer. The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resourc | DetachInstancesFromLoadBalancer | |
detach-static-ipDetaches a static IP from the Amazon Lightsail instance to which it is attached. | DetachStaticIp | |
disable-add-onDisables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide. | DisableAddOn | |
download-default-key-pairDownloads the regional Amazon Lightsail default key pair. This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region. | DownloadDefaultKeyPair | |
enable-add-onEnables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide. | EnableAddOn | |
export-snapshotExports 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 create cloud formation stack operation to create new Amazon EC2 instances. Exported instance snapshots appea | ExportSnapshot | |
get-active-namesReturns the names of all active (not deleted) resources. | GetActiveNames | |
get-alarmsReturns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource. An alarm is used to monitor a single metric for one of your resour | GetAlarms | |
get-auto-snapshotsReturns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide. | GetAutoSnapshots | |
get-blueprintsReturns the list of available instance images, or blueprints. You can use a blueprint to create a new instance 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. Use active | GetBlueprints | |
get-bucket-access-keysReturns the existing access key IDs for the specified Amazon Lightsail bucket. This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, | GetBucketAccessKeys | |
get-bucket-bundlesReturns the bundles that you can apply to a Amazon Lightsail bucket. The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket. Use the UpdateBucketBundle action to update the bundle for a bucket. | GetBucketBundles | |
get-bucket-metric-dataReturns the data points of a specific metric for an Amazon Lightsail bucket. Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects. | GetBucketMetricData | |
get-bucketsReturns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets. For more information about buckets, see Buckets in Amazo | GetBuckets | |
get-bundlesReturns the bundles that you can apply to an Amazon Lightsail instance when you create it. A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota. Bundles are referred to | GetBundles | |
get-certificatesReturns information about one or more Amazon Lightsail SSL/TLS certificates. To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags. | GetCertificates | |
get-cloud-formation-stack-recordsReturns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot. | GetCloudFormationStackRecords | |
get-contact-methodsReturns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number cont | GetContactMethods | |
get-container-api-metadataReturns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin. | GetContainerAPIMetadata | |
get-container-imagesReturns the container images that are registered to your Amazon Lightsail container service. If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not | GetContainerImages | |
get-container-logReturns the log events of a container of your Amazon Lightsail container service. If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service. Container logs ar | GetContainerLog | |
get-container-service-deploymentsReturns the deployments for your Amazon Lightsail container service A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service. The deployments are ordered by version in ascending order. The newest version is listed at the top | GetContainerServiceDeployments | |
get-container-service-metric-dataReturns the data points of a specific metric of your Amazon Lightsail container service. Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. | GetContainerServiceMetricData | |
get-container-service-powersReturns the list of powers that can be specified for your Amazon Lightsail container services. The power specifies the amount of memory, the number of vCPUs, and the base price of the container service. | GetContainerServicePowers | |
get-container-servicesReturns information about one or more of your Amazon Lightsail container services. | GetContainerServices | |
get-cost-estimateRetrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted. | GetCostEstimate | |
get-diskReturns information about a specific block storage disk. | GetDisk | |
get-disk-snapshotReturns information about a specific block storage disk snapshot. | GetDiskSnapshot | |
get-disk-snapshotsReturns information about all block storage disk snapshots in your AWS account and region. | GetDiskSnapshots | |
get-disksReturns information about all block storage disks in your AWS account and region. | GetDisks | |
get-distribution-bundlesReturns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions. A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution. | GetDistributionBundles | |
get-distribution-latest-cache-resetReturns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution. | GetDistributionLatestCacheReset | |
get-distribution-metric-dataReturns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and perform | GetDistributionMetricData | |
get-distributionsReturns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions. | GetDistributions | |
get-domainReturns information about a specific domain recordset. | GetDomain | |
get-domainsReturns a list of all domains in the user's account. | GetDomains | |
get-export-snapshot-recordsReturns all export snapshot records created as a result of the export snapshot operation. An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the CreateCloudFormationStack action. | GetExportSnapshotRecords | |
get-instanceReturns information about a specific Amazon Lightsail instance, which is a virtual private server. | GetInstance | |
get-instance-access-detailsReturns temporary SSH keys you can use to connect to a specific virtual private server, or instance. The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Devel | GetInstanceAccessDetails | |
get-instance-metric-dataReturns the data points for the specified Amazon Lightsail instance metric, given an instance name. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your r | GetInstanceMetricData | |
get-instance-port-statesReturns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol. | GetInstancePortStates | |
get-instance-snapshotReturns information about a specific instance snapshot. | GetInstanceSnapshot | |
get-instance-snapshotsReturns all instance snapshots for the user's account. | GetInstanceSnapshots | |
get-instance-stateReturns the state of a specific instance. Works on one instance at a time. | GetInstanceState | |
get-instancesReturns information about all Amazon Lightsail virtual private servers, or instances. | GetInstances | |
get-key-pairReturns information about a specific key pair. | GetKeyPair | |
get-key-pairsReturns information about all key pairs in the user's account. | GetKeyPairs | |
get-load-balancerReturns information about the specified Lightsail load balancer. | GetLoadBalancer | |
get-load-balancer-metric-dataReturns information about health metrics for your Lightsail load balancer. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. | GetLoadBalancerMetricData | |
get-load-balancer-tls-certificatesReturns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is | GetLoadBalancerTlsCertificates | |
get-load-balancer-tls-policiesReturns a list of TLS security policies that you can apply to Lightsail load balancers. For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide. | GetLoadBalancerTlsPolicies | |
get-load-balancersReturns information about all load balancers in an account. | GetLoadBalancers | |
get-operationReturns 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. | GetOperation | |
get-operationsReturns information about all operations. Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request. | GetOperations | |
get-operations-for-resourceGets operations for a specific resource (an instance or a static IP). | GetOperationsForResource | |
get-regionsReturns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region. | GetRegions | |
get-relational-databaseReturns information about a specific database in Amazon Lightsail. | GetRelationalDatabase | |
get-relational-database-blueprintsReturns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. You can use a blueprint ID to create a new database that runs a specific database engine. | GetRelationalDatabaseBlueprints | |
get-relational-database-bundlesReturns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database. You can use a bundle ID to create a new database with explicit performance specifications. | GetRelationalDatabaseBundles | |
get-relational-database-eventsReturns a list of events for a specific database in Amazon Lightsail. | GetRelationalDatabaseEvents | |
get-relational-database-log-eventsReturns a list of log events for a database in Amazon Lightsail. | GetRelationalDatabaseLogEvents | |
get-relational-database-log-streamsReturns a list of available log streams for a specific database in Amazon Lightsail. | GetRelationalDatabaseLogStreams | |
get-relational-database-master-user-passwordReturns the current, previous, or pending versions of the master user password for a Lightsail database. The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. | GetRelationalDatabaseMasterUserPassword | |
get-relational-database-metric-dataReturns the data points of the specified metric for a database in Amazon Lightsail. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. | GetRelationalDatabaseMetricData | |
get-relational-database-parametersReturns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a | GetRelationalDatabaseParameters | |
get-relational-database-snapshotReturns information about a specific database snapshot in Amazon Lightsail. | GetRelationalDatabaseSnapshot | |
get-relational-database-snapshotsReturns information about all of your database snapshots in Amazon Lightsail. | GetRelationalDatabaseSnapshots | |
get-relational-databasesReturns information about all of your databases in Amazon Lightsail. | GetRelationalDatabases | |
get-setup-historyReturns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance. | GetSetupHistory | |
get-static-ipReturns information about an Amazon Lightsail static IP. | GetStaticIp | |
get-static-ipsReturns information about all static IPs in the user's account. | GetStaticIps | |
import-key-pairImports a public SSH key from a specific key pair. | ImportKeyPair | |
is-vpc-peeredReturns a Boolean value indicating whether your Lightsail VPC is peered. | IsVpcPeered | |
open-instance-public-portsOpens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For | OpenInstancePublicPorts | |
peer-vpcPeers the Lightsail VPC with the user's default VPC. | PeerVpc | |
put-alarmCreates or updates an alarm, and associates it with the specified metric. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more infor | PutAlarm | |
put-instance-public-portsOpens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to o | PutInstancePublicPorts | |
reboot-instanceRestarts a specific instance. The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide. | RebootInstance | |
reboot-relational-databaseRestarts a specific database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. | RebootRelationalDatabase | |
register-container-imageRegisters a container image to your Amazon Lightsail container service. This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on you | RegisterContainerImage | |
release-static-ipDeletes a specific static IP from your account. | ReleaseStaticIp | |
reset-distribution-cacheDeletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution. After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin. | ResetDistributionCache | |
send-contact-method-verificationSends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact me | SendContactMethodVerification | |
set-ip-address-typeSets the IP address type for an Amazon Lightsail resource. Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only. | SetIpAddressType | |
set-resource-access-for-bucketSets the Amazon Lightsail resources that can access the specified Lightsail bucket. Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region. | SetResourceAccessForBucket | |
setup-instance-httpsCreates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance. If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length. | SetupInstanceHttps | |
start-gui-sessionInitiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires. | StartGUISession | |
start-instanceStarts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. 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 sta | StartInstance | |
start-relational-databaseStarts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more | StartRelationalDatabase | |
stop-gui-sessionTerminates a web-based Amazon DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost. | StopGUISession | |
stop-instanceStops a specific Amazon Lightsail instance that is currently running. 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 | StopInstance | |
stop-relational-databaseStops a specific database that is currently running in Amazon Lightsail. If you don't manually start your database instance after it has been stopped for seven consecutive days, Amazon Lightsail automatically starts it for you. This action helps ensure that your database instance doesn't fall behin | StopRelationalDatabase | |
tag-resourceAdds 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 Amazon Lightsail Developer Guide. The tag resource operation | TagResource | |
test-alarmTests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of | TestAlarm | |
unpeer-vpcUnpeers the Lightsail VPC from the user's default VPC. | UnpeerVpc | |
untag-resourceDeletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail D | UntagResource | |
update-bucketUpdates an existing Amazon Lightsail bucket. Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket. | UpdateBucket | |
update-bucket-bundleUpdates the bundle, or storage plan, of an existing Amazon Lightsail bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can upd | UpdateBucketBundle | |
update-container-serviceUpdates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names. | UpdateContainerService | |
update-distributionUpdates an existing Amazon Lightsail content delivery network (CDN) distribution. Use this action to update the configuration of your existing distribution. | UpdateDistribution | |
update-distribution-bundleUpdates the bundle of your Amazon Lightsail content delivery network (CDN) distribution. A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution. Update your distribution's bundle if your distribution is going over its monthly network transfer quota a | UpdateDistributionBundle | |
update-domain-entryUpdates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide. | UpdateDomainEntry | |
update-instance-metadata-optionsModifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance or GetInstances API operation initially responds with a state of pending. After the parameter modifications are successfully applied, the | UpdateInstanceMetadataOptions | |
update-load-balancer-attributeUpdates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail | UpdateLoadBalancerAttribute | |
update-relational-databaseAllows the update of one or more attributes of a database in Amazon Lightsail. Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. The update relational database operation supports tag-based access | UpdateRelationalDatabase | |
update-relational-database-parametersAllows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parame | UpdateRelationalDatabaseParameters |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterLightsail