Class: Aws::Lightsail::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Lightsail::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb
Overview
An API client for Lightsail. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Lightsail::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#allocate_static_ip(params = {}) ⇒ Types::AllocateStaticIpResult
Allocates a static IP address.
-
#attach_certificate_to_distribution(params = {}) ⇒ Types::AttachCertificateToDistributionResult
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
-
#attach_disk(params = {}) ⇒ Types::AttachDiskResult
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
-
#attach_instances_to_load_balancer(params = {}) ⇒ Types::AttachInstancesToLoadBalancerResult
Attaches one or more Lightsail instances to a load balancer.
-
#attach_load_balancer_tls_certificate(params = {}) ⇒ Types::AttachLoadBalancerTlsCertificateResult
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
-
#attach_static_ip(params = {}) ⇒ Types::AttachStaticIpResult
Attaches a static IP address to a specific Amazon Lightsail instance.
-
#close_instance_public_ports(params = {}) ⇒ Types::CloseInstancePublicPortsResult
Closes ports for a specific Amazon Lightsail instance.
-
#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResult
Copies 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.
-
#create_certificate(params = {}) ⇒ Types::CreateCertificateResult
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
-
#create_cloud_formation_stack(params = {}) ⇒ Types::CreateCloudFormationStackResult
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot.
-
#create_contact_method(params = {}) ⇒ Types::CreateContactMethodResult
Creates an email or SMS text message contact method.
-
#create_container_service(params = {}) ⇒ Types::CreateContainerServiceResult
Creates an Amazon Lightsail container service.
-
#create_container_service_deployment(params = {}) ⇒ Types::CreateContainerServiceDeploymentResult
Creates a deployment for your Amazon Lightsail container service.
-
#create_container_service_registry_login(params = {}) ⇒ Types::CreateContainerServiceRegistryLoginResult
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine.
-
#create_disk(params = {}) ⇒ Types::CreateDiskResult
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g.,
us-east-2a
). -
#create_disk_from_snapshot(params = {}) ⇒ Types::CreateDiskFromSnapshotResult
Creates a block storage disk from a manual or automatic snapshot of a disk.
-
#create_disk_snapshot(params = {}) ⇒ Types::CreateDiskSnapshotResult
Creates a snapshot of a block storage disk.
-
#create_distribution(params = {}) ⇒ Types::CreateDistributionResult
Creates an Amazon Lightsail content delivery network (CDN) distribution.
-
#create_domain(params = {}) ⇒ Types::CreateDomainResult
Creates a domain resource for the specified domain (e.g., example.com).
-
#create_domain_entry(params = {}) ⇒ Types::CreateDomainEntryResult
Creates 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).
-
#create_instance_snapshot(params = {}) ⇒ Types::CreateInstanceSnapshotResult
Creates a snapshot of a specific virtual private server, or instance.
-
#create_instances(params = {}) ⇒ Types::CreateInstancesResult
Creates one or more Amazon Lightsail instances.
-
#create_instances_from_snapshot(params = {}) ⇒ Types::CreateInstancesFromSnapshotResult
Creates one or more new instances from a manual or automatic snapshot of an instance.
-
#create_key_pair(params = {}) ⇒ Types::CreateKeyPairResult
Creates an SSH key pair.
-
#create_load_balancer(params = {}) ⇒ Types::CreateLoadBalancerResult
Creates a Lightsail load balancer.
-
#create_load_balancer_tls_certificate(params = {}) ⇒ Types::CreateLoadBalancerTlsCertificateResult
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
-
#create_relational_database(params = {}) ⇒ Types::CreateRelationalDatabaseResult
Creates a new database in Amazon Lightsail.
-
#create_relational_database_from_snapshot(params = {}) ⇒ Types::CreateRelationalDatabaseFromSnapshotResult
Creates a new database from an existing database snapshot in Amazon Lightsail.
-
#create_relational_database_snapshot(params = {}) ⇒ Types::CreateRelationalDatabaseSnapshotResult
Creates a snapshot of your database in Amazon Lightsail.
-
#delete_alarm(params = {}) ⇒ Types::DeleteAlarmResult
Deletes an alarm.
-
#delete_auto_snapshot(params = {}) ⇒ Types::DeleteAutoSnapshotResult
Deletes an automatic snapshot of an instance or disk.
-
#delete_certificate(params = {}) ⇒ Types::DeleteCertificateResult
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
-
#delete_contact_method(params = {}) ⇒ Types::DeleteContactMethodResult
Deletes a contact method.
-
#delete_container_image(params = {}) ⇒ Struct
Deletes a container image that is registered to your Amazon Lightsail container service.
-
#delete_container_service(params = {}) ⇒ Struct
Deletes your Amazon Lightsail container service.
-
#delete_disk(params = {}) ⇒ Types::DeleteDiskResult
Deletes the specified block storage disk.
-
#delete_disk_snapshot(params = {}) ⇒ Types::DeleteDiskSnapshotResult
Deletes the specified disk snapshot.
-
#delete_distribution(params = {}) ⇒ Types::DeleteDistributionResult
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
-
#delete_domain(params = {}) ⇒ Types::DeleteDomainResult
Deletes the specified domain recordset and all of its domain records.
-
#delete_domain_entry(params = {}) ⇒ Types::DeleteDomainEntryResult
Deletes a specific domain entry.
-
#delete_instance(params = {}) ⇒ Types::DeleteInstanceResult
Deletes an Amazon Lightsail instance.
-
#delete_instance_snapshot(params = {}) ⇒ Types::DeleteInstanceSnapshotResult
Deletes a specific snapshot of a virtual private server (or instance).
-
#delete_key_pair(params = {}) ⇒ Types::DeleteKeyPairResult
Deletes a specific SSH key pair.
-
#delete_known_host_keys(params = {}) ⇒ Types::DeleteKnownHostKeysResult
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance.
-
#delete_load_balancer(params = {}) ⇒ Types::DeleteLoadBalancerResult
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
-
#delete_load_balancer_tls_certificate(params = {}) ⇒ Types::DeleteLoadBalancerTlsCertificateResult
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
-
#delete_relational_database(params = {}) ⇒ Types::DeleteRelationalDatabaseResult
Deletes a database in Amazon Lightsail.
-
#delete_relational_database_snapshot(params = {}) ⇒ Types::DeleteRelationalDatabaseSnapshotResult
Deletes a database snapshot in Amazon Lightsail.
-
#detach_certificate_from_distribution(params = {}) ⇒ Types::DetachCertificateFromDistributionResult
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
-
#detach_disk(params = {}) ⇒ Types::DetachDiskResult
Detaches a stopped block storage disk from a Lightsail instance.
-
#detach_instances_from_load_balancer(params = {}) ⇒ Types::DetachInstancesFromLoadBalancerResult
Detaches the specified instances from a Lightsail load balancer.
-
#detach_static_ip(params = {}) ⇒ Types::DetachStaticIpResult
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
-
#disable_add_on(params = {}) ⇒ Types::DisableAddOnResult
Disables an add-on for an Amazon Lightsail resource.
-
#download_default_key_pair(params = {}) ⇒ Types::DownloadDefaultKeyPairResult
Downloads the default SSH key pair from the user's account.
-
#enable_add_on(params = {}) ⇒ Types::EnableAddOnResult
Enables or modifies an add-on for an Amazon Lightsail resource.
-
#export_snapshot(params = {}) ⇒ Types::ExportSnapshotResult
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
-
#get_active_names(params = {}) ⇒ Types::GetActiveNamesResult
Returns the names of all active (not deleted) resources.
-
#get_alarms(params = {}) ⇒ Types::GetAlarmsResult
Returns information about the configured alarms.
-
#get_auto_snapshots(params = {}) ⇒ Types::GetAutoSnapshotsResult
Returns the available automatic snapshots for an instance or disk.
-
#get_blueprints(params = {}) ⇒ Types::GetBlueprintsResult
Returns the list of available instance images, or blueprints.
-
#get_bundles(params = {}) ⇒ Types::GetBundlesResult
Returns the list of bundles that are available for purchase.
-
#get_certificates(params = {}) ⇒ Types::GetCertificatesResult
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
-
#get_cloud_formation_stack_records(params = {}) ⇒ Types::GetCloudFormationStackRecordsResult
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. -
#get_contact_methods(params = {}) ⇒ Types::GetContactMethodsResult
Returns information about the configured contact methods.
-
#get_container_api_metadata(params = {}) ⇒ Types::GetContainerAPIMetadataResult
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
-
#get_container_images(params = {}) ⇒ Types::GetContainerImagesResult
Returns the container images that are registered to your Amazon Lightsail container service.
-
#get_container_log(params = {}) ⇒ Types::GetContainerLogResult
Returns the log events of a container of your Amazon Lightsail container service.
-
#get_container_service_deployments(params = {}) ⇒ Types::GetContainerServiceDeploymentsResult
Returns the deployments for your Amazon Lightsail container service.
-
#get_container_service_metric_data(params = {}) ⇒ Types::GetContainerServiceMetricDataResult
Returns the data points of a specific metric of your Amazon Lightsail container service.
-
#get_container_service_powers(params = {}) ⇒ Types::GetContainerServicePowersResult
Returns the list of powers that can be specified for your Amazon Lightsail container services.
-
#get_container_services(params = {}) ⇒ Types::ContainerServicesListResult
Returns information about one or more of your Amazon Lightsail container services.
-
#get_disk(params = {}) ⇒ Types::GetDiskResult
Returns information about a specific block storage disk.
-
#get_disk_snapshot(params = {}) ⇒ Types::GetDiskSnapshotResult
Returns information about a specific block storage disk snapshot.
-
#get_disk_snapshots(params = {}) ⇒ Types::GetDiskSnapshotsResult
Returns information about all block storage disk snapshots in your AWS account and region.
-
#get_disks(params = {}) ⇒ Types::GetDisksResult
Returns information about all block storage disks in your AWS account and region.
-
#get_distribution_bundles(params = {}) ⇒ Types::GetDistributionBundlesResult
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions.
-
#get_distribution_latest_cache_reset(params = {}) ⇒ Types::GetDistributionLatestCacheResetResult
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
-
#get_distribution_metric_data(params = {}) ⇒ Types::GetDistributionMetricDataResult
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
-
#get_distributions(params = {}) ⇒ Types::GetDistributionsResult
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
-
#get_domain(params = {}) ⇒ Types::GetDomainResult
Returns information about a specific domain recordset.
-
#get_domains(params = {}) ⇒ Types::GetDomainsResult
Returns a list of all domains in the user's account.
-
#get_export_snapshot_records(params = {}) ⇒ Types::GetExportSnapshotRecordsResult
Returns the export snapshot record created as a result of the
export snapshot
operation. -
#get_instance(params = {}) ⇒ Types::GetInstanceResult
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
-
#get_instance_access_details(params = {}) ⇒ Types::GetInstanceAccessDetailsResult
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
-
#get_instance_metric_data(params = {}) ⇒ Types::GetInstanceMetricDataResult
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
-
#get_instance_port_states(params = {}) ⇒ Types::GetInstancePortStatesResult
Returns 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.
-
#get_instance_snapshot(params = {}) ⇒ Types::GetInstanceSnapshotResult
Returns information about a specific instance snapshot.
-
#get_instance_snapshots(params = {}) ⇒ Types::GetInstanceSnapshotsResult
Returns all instance snapshots for the user's account.
-
#get_instance_state(params = {}) ⇒ Types::GetInstanceStateResult
Returns the state of a specific instance.
-
#get_instances(params = {}) ⇒ Types::GetInstancesResult
Returns information about all Amazon Lightsail virtual private servers, or instances.
-
#get_key_pair(params = {}) ⇒ Types::GetKeyPairResult
Returns information about a specific key pair.
-
#get_key_pairs(params = {}) ⇒ Types::GetKeyPairsResult
Returns information about all key pairs in the user's account.
-
#get_load_balancer(params = {}) ⇒ Types::GetLoadBalancerResult
Returns information about the specified Lightsail load balancer.
-
#get_load_balancer_metric_data(params = {}) ⇒ Types::GetLoadBalancerMetricDataResult
Returns information about health metrics for your Lightsail load balancer.
-
#get_load_balancer_tls_certificates(params = {}) ⇒ Types::GetLoadBalancerTlsCertificatesResult
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
-
#get_load_balancers(params = {}) ⇒ Types::GetLoadBalancersResult
Returns information about all load balancers in an account.
-
#get_operation(params = {}) ⇒ Types::GetOperationResult
Returns information about a specific operation.
-
#get_operations(params = {}) ⇒ Types::GetOperationsResult
Returns information about all operations.
-
#get_operations_for_resource(params = {}) ⇒ Types::GetOperationsForResourceResult
Gets operations for a specific resource (e.g., an instance or a static IP).
-
#get_regions(params = {}) ⇒ Types::GetRegionsResult
Returns a list of all valid regions for Amazon Lightsail.
-
#get_relational_database(params = {}) ⇒ Types::GetRelationalDatabaseResult
Returns information about a specific database in Amazon Lightsail.
-
#get_relational_database_blueprints(params = {}) ⇒ Types::GetRelationalDatabaseBlueprintsResult
Returns a list of available database blueprints in Amazon Lightsail.
-
#get_relational_database_bundles(params = {}) ⇒ Types::GetRelationalDatabaseBundlesResult
Returns the list of bundles that are available in Amazon Lightsail.
-
#get_relational_database_events(params = {}) ⇒ Types::GetRelationalDatabaseEventsResult
Returns a list of events for a specific database in Amazon Lightsail.
-
#get_relational_database_log_events(params = {}) ⇒ Types::GetRelationalDatabaseLogEventsResult
Returns a list of log events for a database in Amazon Lightsail.
-
#get_relational_database_log_streams(params = {}) ⇒ Types::GetRelationalDatabaseLogStreamsResult
Returns a list of available log streams for a specific database in Amazon Lightsail.
-
#get_relational_database_master_user_password(params = {}) ⇒ Types::GetRelationalDatabaseMasterUserPasswordResult
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
-
#get_relational_database_metric_data(params = {}) ⇒ Types::GetRelationalDatabaseMetricDataResult
Returns the data points of the specified metric for a database in Amazon Lightsail.
-
#get_relational_database_parameters(params = {}) ⇒ Types::GetRelationalDatabaseParametersResult
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
-
#get_relational_database_snapshot(params = {}) ⇒ Types::GetRelationalDatabaseSnapshotResult
Returns information about a specific database snapshot in Amazon Lightsail.
-
#get_relational_database_snapshots(params = {}) ⇒ Types::GetRelationalDatabaseSnapshotsResult
Returns information about all of your database snapshots in Amazon Lightsail.
-
#get_relational_databases(params = {}) ⇒ Types::GetRelationalDatabasesResult
Returns information about all of your databases in Amazon Lightsail.
-
#get_static_ip(params = {}) ⇒ Types::GetStaticIpResult
Returns information about a specific static IP.
-
#get_static_ips(params = {}) ⇒ Types::GetStaticIpsResult
Returns information about all static IPs in the user's account.
-
#import_key_pair(params = {}) ⇒ Types::ImportKeyPairResult
Imports a public SSH key from a specific key pair.
-
#is_vpc_peered(params = {}) ⇒ Types::IsVpcPeeredResult
Returns a Boolean value indicating whether your Lightsail VPC is peered.
-
#open_instance_public_ports(params = {}) ⇒ Types::OpenInstancePublicPortsResult
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
-
#peer_vpc(params = {}) ⇒ Types::PeerVpcResult
Tries to peer the Lightsail VPC with the user's default VPC.
-
#put_alarm(params = {}) ⇒ Types::PutAlarmResult
Creates or updates an alarm, and associates it with the specified metric.
-
#put_instance_public_ports(params = {}) ⇒ Types::PutInstancePublicPortsResult
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
-
#reboot_instance(params = {}) ⇒ Types::RebootInstanceResult
Restarts a specific instance.
-
#reboot_relational_database(params = {}) ⇒ Types::RebootRelationalDatabaseResult
Restarts a specific database in Amazon Lightsail.
-
#register_container_image(params = {}) ⇒ Types::RegisterContainerImageResult
Registers a container image to your Amazon Lightsail container service.
-
#release_static_ip(params = {}) ⇒ Types::ReleaseStaticIpResult
Deletes a specific static IP from your account.
-
#reset_distribution_cache(params = {}) ⇒ Types::ResetDistributionCacheResult
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
-
#send_contact_method_verification(params = {}) ⇒ Types::SendContactMethodVerificationResult
Sends a verification request to an email contact method to ensure it's owned by the requester.
-
#set_ip_address_type(params = {}) ⇒ Types::SetIpAddressTypeResult
Sets the IP address type for an Amazon Lightsail resource.
-
#start_instance(params = {}) ⇒ Types::StartInstanceResult
Starts a specific Amazon Lightsail instance from a stopped state.
-
#start_relational_database(params = {}) ⇒ Types::StartRelationalDatabaseResult
Starts a specific database from a stopped state in Amazon Lightsail.
-
#stop_instance(params = {}) ⇒ Types::StopInstanceResult
Stops a specific Amazon Lightsail instance that is currently running.
-
#stop_relational_database(params = {}) ⇒ Types::StopRelationalDatabaseResult
Stops a specific database that is currently running in Amazon Lightsail.
-
#tag_resource(params = {}) ⇒ Types::TagResourceResult
Adds one or more tags to the specified Amazon Lightsail resource.
-
#test_alarm(params = {}) ⇒ Types::TestAlarmResult
Tests an alarm by displaying a banner on the Amazon Lightsail console.
-
#unpeer_vpc(params = {}) ⇒ Types::UnpeerVpcResult
Attempts to unpeer the Lightsail VPC from the user's default VPC.
-
#untag_resource(params = {}) ⇒ Types::UntagResourceResult
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
-
#update_container_service(params = {}) ⇒ Types::UpdateContainerServiceResult
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
-
#update_distribution(params = {}) ⇒ Types::UpdateDistributionResult
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
-
#update_distribution_bundle(params = {}) ⇒ Types::UpdateDistributionBundleResult
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
-
#update_domain_entry(params = {}) ⇒ Types::UpdateDomainEntryResult
Updates a domain recordset after it is created.
-
#update_load_balancer_attribute(params = {}) ⇒ Types::UpdateLoadBalancerAttributeResult
Updates the specified attribute for a load balancer.
-
#update_relational_database(params = {}) ⇒ Types::UpdateRelationalDatabaseResult
Allows the update of one or more attributes of a database in Amazon Lightsail.
-
#update_relational_database_parameters(params = {}) ⇒ Types::UpdateRelationalDatabaseParametersResult
Allows the update of one or more parameters of a database in Amazon Lightsail.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#allocate_static_ip(params = {}) ⇒ Types::AllocateStaticIpResult
Allocates a static IP address.
376 377 378 379 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 376 def allocate_static_ip(params = {}, = {}) req = build_request(:allocate_static_ip, params) req.send_request() end |
#attach_certificate_to_distribution(params = {}) ⇒ Types::AttachCertificateToDistributionResult
Attaches 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 that you
can attach to your distribution.
Only certificates created in the us-east-1
AWS Region can be
attached to Lightsail distributions. Lightsail distributions are
global resources that can reference an origin in any AWS Region, and
distribute its content globally. However, all distributions are
located in the us-east-1
Region.
451 452 453 454 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 451 def attach_certificate_to_distribution(params = {}, = {}) req = build_request(:attach_certificate_to_distribution, params) req.send_request() end |
#attach_disk(params = {}) ⇒ Types::AttachDiskResult
Attaches 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 Lightsail Dev Guide.
510 511 512 513 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 510 def attach_disk(params = {}, = {}) req = build_request(:attach_disk, params) req.send_request() end |
#attach_instances_to_load_balancer(params = {}) ⇒ Types::AttachInstancesToLoadBalancerResult
Attaches 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 identified by
load balancer name
. For more information, see the Lightsail Dev
Guide.
575 576 577 578 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 575 def attach_instances_to_load_balancer(params = {}, = {}) req = build_request(:attach_instances_to_load_balancer, params) req.send_request() end |
#attach_load_balancer_tls_certificate(params = {}) ⇒ Types::AttachLoadBalancerTlsCertificateResult
Attaches 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 account. Use the
AttachLoadBalancerTlsCertificate
action with the non-attached
certificate, and it will replace the existing one and become the
attached certificate.
The AttachLoadBalancerTlsCertificate
operation supports tag-based
access control via resource tags applied to the resource identified by
load balancer name
. For more information, see the Lightsail Dev
Guide.
639 640 641 642 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 639 def attach_load_balancer_tls_certificate(params = {}, = {}) req = build_request(:attach_load_balancer_tls_certificate, params) req.send_request() end |
#attach_static_ip(params = {}) ⇒ Types::AttachStaticIpResult
Attaches a static IP address to a specific Amazon Lightsail instance.
684 685 686 687 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 684 def attach_static_ip(params = {}, = {}) req = build_request(:attach_static_ip, params) req.send_request() end |
#close_instance_public_ports(params = {}) ⇒ Types::CloseInstancePublicPortsResult
Closes 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 Lightsail Dev
Guide.
744 745 746 747 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 744 def close_instance_public_ports(params = {}, = {}) req = build_request(:close_instance_public_ports, params) req.send_request() end |
#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResult
Copies 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 AWS Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the source
region
, source snapshot name
, and target snapshot name
parameters.
When copying an automatic snapshot, be sure to define the source
region
, source resource name
, target snapshot name
, and either
the restore date
or the use latest restorable auto snapshot
parameters.
872 873 874 875 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 872 def copy_snapshot(params = {}, = {}) req = build_request(:copy_snapshot, params) req.send_request() end |
#create_certificate(params = {}) ⇒ Types::CreateCertificateResult
Creates 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
action to use the certificate and its domains
with your container service.
Only certificates created in the us-east-1
AWS Region can be
attached to Lightsail distributions. Lightsail distributions are
global resources that can reference an origin in any AWS Region, and
distribute its content globally. However, all distributions are
located in the us-east-1
Region.
995 996 997 998 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 995 def create_certificate(params = {}, = {}) req = build_request(:create_certificate, params) req.send_request() end |
#create_cloud_formation_stack(params = {}) ⇒ Types::CreateCloudFormationStackResult
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 get cloud formation stack
records
operation to get a list of the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before
running the create cloud formation stack
operation again with the
same export snapshot record.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1055 def create_cloud_formation_stack(params = {}, = {}) req = build_request(:create_cloud_formation_stack, params) req.send_request() end |
#create_contact_method(params = {}) ⇒ Types::CreateContactMethodResult
Creates 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 AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
1152 1153 1154 1155 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1152 def create_contact_method(params = {}, = {}) req = build_request(:create_contact_method, params) req.send_request() end |
#create_container_service(params = {}) ⇒ Types::CreateContainerServiceResult
Creates 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.
1364 1365 1366 1367 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1364 def create_container_service(params = {}, = {}) req = build_request(:create_container_service, params) req.send_request() end |
#create_container_service_deployment(params = {}) ⇒ Types::CreateContainerServiceDeploymentResult
Creates 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 that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Lightsail Dev Guide.
1497 1498 1499 1500 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1497 def create_container_service_deployment(params = {}, = {}) req = build_request(:create_container_service_deployment, params) req.send_request() end |
#create_container_service_registry_login(params = {}) ⇒ Types::CreateContainerServiceRegistryLoginResult
Creates 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 use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
After you push your container images to the container image registry
of your Lightsail account, use the RegisterContainerImage
action to
register the pushed images to a specific Lightsail container service.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1549 def create_container_service_registry_login(params = {}, = {}) req = build_request(:create_container_service_registry_login, params) req.send_request() end |
#create_disk(params = {}) ⇒ Types::CreateDiskResult
Creates a block storage disk that can be attached to an Amazon
Lightsail instance in the same Availability Zone (e.g., us-east-2a
).
The create disk
operation supports tag-based access control via
request tags. For more information, see the Lightsail Dev Guide.
1634 1635 1636 1637 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1634 def create_disk(params = {}, = {}) req = build_request(:create_disk, params) req.send_request() end |
#create_disk_from_snapshot(params = {}) ⇒ Types::CreateDiskFromSnapshotResult
Creates 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 (e.g., us-east-2a
).
The create disk from snapshot
operation supports tag-based access
control via request tags and resource tags applied to the resource
identified by disk snapshot name
. For more information, see the
Lightsail Dev Guide.
1795 1796 1797 1798 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1795 def create_disk_from_snapshot(params = {}, = {}) req = build_request(:create_disk_from_snapshot, params) req.send_request() end |
#create_disk_snapshot(params = {}) ⇒ Types::CreateDiskSnapshotResult
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.
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.
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 instance name
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.
The create disk snapshot
operation supports tag-based access control
via request tags. For more information, see the Lightsail Dev
Guide.
1902 1903 1904 1905 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1902 def create_disk_snapshot(params = {}, = {}) req = build_request(:create_disk_snapshot, params) req.send_request() end |
#create_distribution(params = {}) ⇒ Types::CreateDistributionResult
Creates 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 Lightsail.
2078 2079 2080 2081 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2078 def create_distribution(params = {}, = {}) req = build_request(:create_distribution, params) req.send_request() end |
#create_domain(params = {}) ⇒ Types::CreateDomainResult
Creates a domain resource for the specified domain (e.g., example.com).
The create domain
operation supports tag-based access control via
request tags. For more information, see the Lightsail Dev Guide.
2144 2145 2146 2147 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2144 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#create_domain_entry(params = {}) ⇒ Types::CreateDomainEntryResult
Creates 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 resource tags applied to the resource identified by domain name
.
For more information, see the Lightsail Dev Guide.
2210 2211 2212 2213 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2210 def create_domain_entry(params = {}, = {}) req = build_request(:create_domain_entry, params) req.send_request() end |
#create_instance_snapshot(params = {}) ⇒ Types::CreateInstanceSnapshotResult
Creates 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 Lightsail Dev
Guide.
2276 2277 2278 2279 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2276 def create_instance_snapshot(params = {}, = {}) req = build_request(:create_instance_snapshot, params) req.send_request() end |
#create_instances(params = {}) ⇒ Types::CreateInstancesResult
Creates one or more Amazon Lightsail instances.
The create instances
operation supports tag-based access control via
request tags. For more information, see the Lightsail Dev Guide.
2419 2420 2421 2422 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2419 def create_instances(params = {}, = {}) req = build_request(:create_instances, params) req.send_request() end |
#create_instances_from_snapshot(params = {}) ⇒ Types::CreateInstancesFromSnapshotResult
Creates 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 Lightsail Dev Guide.
2625 2626 2627 2628 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2625 def create_instances_from_snapshot(params = {}, = {}) req = build_request(:create_instances_from_snapshot, params) req.send_request() end |
#create_key_pair(params = {}) ⇒ Types::CreateKeyPairResult
Creates an SSH key pair.
The create key pair
operation supports tag-based access control via
request tags. For more information, see the Lightsail Dev Guide.
2699 2700 2701 2702 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2699 def create_key_pair(params = {}, = {}) req = build_request(:create_key_pair, params) req.send_request() end |
#create_load_balancer(params = {}) ⇒ Types::CreateLoadBalancerResult
Creates 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 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and
port settings. To change additional load balancer settings, use the
UpdateLoadBalancerAttribute
operation.
The create load balancer
operation supports tag-based access control
via request tags. For more information, see the Lightsail Dev
Guide.
2811 2812 2813 2814 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2811 def create_load_balancer(params = {}, = {}) req = build_request(:create_load_balancer, params) req.send_request() end |
#create_load_balancer_tls_certificate(params = {}) ⇒ Types::CreateLoadBalancerTlsCertificateResult
Creates 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
. For more information, see the Lightsail Dev
Guide.
2901 2902 2903 2904 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2901 def create_load_balancer_tls_certificate(params = {}, = {}) req = build_request(:create_load_balancer_tls_certificate, params) req.send_request() end |
#create_relational_database(params = {}) ⇒ Types::CreateRelationalDatabaseResult
Creates a new database in Amazon Lightsail.
The create relational database
operation supports tag-based access
control via request tags. For more information, see the Lightsail Dev
Guide.
3090 3091 3092 3093 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3090 def create_relational_database(params = {}, = {}) req = build_request(:create_relational_database, params) req.send_request() end |
#create_relational_database_from_snapshot(params = {}) ⇒ Types::CreateRelationalDatabaseFromSnapshotResult
Creates 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 snapshot
operation supports
tag-based access control via request tags and resource tags applied to
the resource identified by relationalDatabaseSnapshotName. For more
information, see the Lightsail Dev Guide.
3227 3228 3229 3230 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3227 def create_relational_database_from_snapshot(params = {}, = {}) req = build_request(:create_relational_database_from_snapshot, params) req.send_request() end |
#create_relational_database_snapshot(params = {}) ⇒ Types::CreateRelationalDatabaseSnapshotResult
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.
The create relational database snapshot
operation supports tag-based
access control via request tags. For more information, see the
Lightsail Dev Guide.
3299 3300 3301 3302 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3299 def create_relational_database_snapshot(params = {}, = {}) req = build_request(:create_relational_database_snapshot, params) req.send_request() end |
#delete_alarm(params = {}) ⇒ Types::DeleteAlarmResult
Deletes 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.
3349 3350 3351 3352 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3349 def delete_alarm(params = {}, = {}) req = build_request(:delete_alarm, params) req.send_request() end |
#delete_auto_snapshot(params = {}) ⇒ Types::DeleteAutoSnapshotResult
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
3402 3403 3404 3405 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3402 def delete_auto_snapshot(params = {}, = {}) req = build_request(:delete_auto_snapshot, params) req.send_request() end |
#delete_certificate(params = {}) ⇒ Types::DeleteCertificateResult
Deletes 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.
3451 3452 3453 3454 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3451 def delete_certificate(params = {}, = {}) req = build_request(:delete_certificate, params) req.send_request() end |
#delete_contact_method(params = {}) ⇒ Types::DeleteContactMethodResult
Deletes 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 AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
3510 3511 3512 3513 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3510 def delete_contact_method(params = {}, = {}) req = build_request(:delete_contact_method, params) req.send_request() end |
#delete_container_image(params = {}) ⇒ Struct
Deletes a container image that is registered to your Amazon Lightsail container service.
3549 3550 3551 3552 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3549 def delete_container_image(params = {}, = {}) req = build_request(:delete_container_image, params) req.send_request() end |
#delete_container_service(params = {}) ⇒ Struct
Deletes your Amazon Lightsail container service.
3571 3572 3573 3574 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3571 def delete_container_service(params = {}, = {}) req = build_request(:delete_container_service, params) req.send_request() end |
#delete_disk(params = {}) ⇒ Types::DeleteDiskResult
Deletes the specified block storage disk. The disk must be in the
available
state (not attached to a Lightsail instance).
deleting
state for several minutes.
The delete disk
operation supports tag-based access control via
resource tags applied to the resource identified by disk name
. For
more information, see the Lightsail Dev Guide.
3630 3631 3632 3633 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3630 def delete_disk(params = {}, = {}) req = build_request(:delete_disk, params) req.send_request() end |
#delete_disk_snapshot(params = {}) ⇒ Types::DeleteDiskSnapshotResult
Deletes 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 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.
The delete disk snapshot
operation supports tag-based access control
via resource tags applied to the resource identified by disk snapshot
name
. For more information, see the Lightsail Dev Guide.
3688 3689 3690 3691 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3688 def delete_disk_snapshot(params = {}, = {}) req = build_request(:delete_disk_snapshot, params) req.send_request() end |
#delete_distribution(params = {}) ⇒ Types::DeleteDistributionResult
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
3732 3733 3734 3735 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3732 def delete_distribution(params = {}, = {}) req = build_request(:delete_distribution, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Types::DeleteDomainResult
Deletes 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 Lightsail Dev Guide.
3780 3781 3782 3783 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3780 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_domain_entry(params = {}) ⇒ Types::DeleteDomainEntryResult
Deletes 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 Lightsail Dev Guide.
3842 3843 3844 3845 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3842 def delete_domain_entry(params = {}, = {}) req = build_request(:delete_domain_entry, params) req.send_request() end |
#delete_instance(params = {}) ⇒ Types::DeleteInstanceResult
Deletes 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 Lightsail Dev Guide.
3896 3897 3898 3899 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3896 def delete_instance(params = {}, = {}) req = build_request(:delete_instance, params) req.send_request() end |
#delete_instance_snapshot(params = {}) ⇒ Types::DeleteInstanceSnapshotResult
Deletes 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 Lightsail Dev
Guide.
3947 3948 3949 3950 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3947 def delete_instance_snapshot(params = {}, = {}) req = build_request(:delete_instance_snapshot, params) req.send_request() end |
#delete_key_pair(params = {}) ⇒ Types::DeleteKeyPairResult
Deletes a specific SSH key pair.
The delete key pair
operation supports tag-based access control via
resource tags applied to the resource identified by key pair name
.
For more information, see the Lightsail Dev Guide.
3995 3996 3997 3998 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3995 def delete_key_pair(params = {}, = {}) req = build_request(:delete_key_pair, params) req.send_request() end |
#delete_known_host_keys(params = {}) ⇒ Types::DeleteKnownHostKeysResult
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.
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 Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
4050 4051 4052 4053 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4050 def delete_known_host_keys(params = {}, = {}) req = build_request(:delete_known_host_keys, params) req.send_request() end |
#delete_load_balancer(params = {}) ⇒ Types::DeleteLoadBalancerResult
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.
The delete load balancer
operation supports tag-based access control
via resource tags applied to the resource identified by load balancer
name
. For more information, see the Lightsail Dev Guide.
4102 4103 4104 4105 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4102 def delete_load_balancer(params = {}, = {}) req = build_request(:delete_load_balancer, params) req.send_request() end |
#delete_load_balancer_tls_certificate(params = {}) ⇒ Types::DeleteLoadBalancerTlsCertificateResult
Deletes 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 Lightsail Dev
Guide.
4166 4167 4168 4169 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4166 def delete_load_balancer_tls_certificate(params = {}, = {}) req = build_request(:delete_load_balancer_tls_certificate, params) req.send_request() end |
#delete_relational_database(params = {}) ⇒ Types::DeleteRelationalDatabaseResult
Deletes 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 Lightsail Dev
Guide.
4244 4245 4246 4247 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4244 def delete_relational_database(params = {}, = {}) req = build_request(:delete_relational_database, params) req.send_request() end |
#delete_relational_database_snapshot(params = {}) ⇒ Types::DeleteRelationalDatabaseSnapshotResult
Deletes 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 Lightsail Dev
Guide.
4294 4295 4296 4297 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4294 def delete_relational_database_snapshot(params = {}, = {}) req = build_request(:delete_relational_database_snapshot, params) req.send_request() end |
#detach_certificate_from_distribution(params = {}) ⇒ Types::DetachCertificateFromDistributionResult
Detaches 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.
4342 4343 4344 4345 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4342 def detach_certificate_from_distribution(params = {}, = {}) req = build_request(:detach_certificate_from_distribution, params) req.send_request() end |
#detach_disk(params = {}) ⇒ Types::DetachDiskResult
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.
The detach disk
operation supports tag-based access control via
resource tags applied to the resource identified by disk name
. For
more information, see the Lightsail Dev Guide.
4394 4395 4396 4397 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4394 def detach_disk(params = {}, = {}) req = build_request(:detach_disk, params) req.send_request() end |
#detach_instances_from_load_balancer(params = {}) ⇒ Types::DetachInstancesFromLoadBalancerResult
Detaches 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 resource identified by
load balancer name
. For more information, see the Lightsail Dev
Guide.
4452 4453 4454 4455 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4452 def detach_instances_from_load_balancer(params = {}, = {}) req = build_request(:detach_instances_from_load_balancer, params) req.send_request() end |
#detach_static_ip(params = {}) ⇒ Types::DetachStaticIpResult
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
4494 4495 4496 4497 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4494 def detach_static_ip(params = {}, = {}) req = build_request(:detach_static_ip, params) req.send_request() end |
#disable_add_on(params = {}) ⇒ Types::DisableAddOnResult
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
4544 4545 4546 4547 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4544 def disable_add_on(params = {}, = {}) req = build_request(:disable_add_on, params) req.send_request() end |
#download_default_key_pair(params = {}) ⇒ Types::DownloadDefaultKeyPairResult
Downloads the default SSH key pair from the user's account.
4565 4566 4567 4568 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4565 def download_default_key_pair(params = {}, = {}) req = build_request(:download_default_key_pair, params) req.send_request() end |
#enable_add_on(params = {}) ⇒ Types::EnableAddOnResult
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
4621 4622 4623 4624 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4621 def enable_add_on(params = {}, = {}) req = build_request(:enable_add_on, params) req.send_request() end |
#export_snapshot(params = {}) ⇒ Types::ExportSnapshotResult
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 create cloud
formation stack
operation to create new Amazon EC2 instances.
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.
The export snapshot
operation supports tag-based access control via
resource tags applied to the resource identified by source snapshot
name
. For more information, see the Lightsail Dev Guide.
get instance snapshots
or get disk snapshots
operations to
get a list of snapshots that you can export to Amazon EC2.