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_bucket(params = {}) ⇒ Types::CreateBucketResult
Creates an Amazon Lightsail bucket.
-
#create_bucket_access_key(params = {}) ⇒ Types::CreateBucketAccessKeyResult
Creates a new access key for the specified Amazon Lightsail bucket.
-
#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 (
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 (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_gui_session_access_details(params = {}) ⇒ Types::CreateGUISessionAccessDetailsResult
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session.
-
#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 a custom SSH key pair that you can use with an Amazon Lightsail instance.
-
#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_bucket(params = {}) ⇒ Types::DeleteBucketResult
Deletes a Amazon Lightsail bucket.
-
#delete_bucket_access_key(params = {}) ⇒ Types::DeleteBucketAccessKeyResult
Deletes an access key for the specified Amazon Lightsail bucket.
-
#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 the specified key pair by removing the public key from Amazon Lightsail.
-
#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 regional Amazon Lightsail default key pair.
-
#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_bucket_access_keys(params = {}) ⇒ Types::GetBucketAccessKeysResult
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
-
#get_bucket_bundles(params = {}) ⇒ Types::GetBucketBundlesResult
Returns the bundles that you can apply to a Amazon Lightsail bucket.
-
#get_bucket_metric_data(params = {}) ⇒ Types::GetBucketMetricDataResult
Returns the data points of a specific metric for an Amazon Lightsail bucket.
-
#get_buckets(params = {}) ⇒ Types::GetBucketsResult
Returns information about one or more Amazon Lightsail buckets.
-
#get_bundles(params = {}) ⇒ Types::GetBundlesResult
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
-
#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_cost_estimate(params = {}) ⇒ Types::GetCostEstimateResult
Retrieves information about the cost estimate for a specified resource.
-
#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 bundles that can be applied to your 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 all export snapshot records 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_balancer_tls_policies(params = {}) ⇒ Types::GetLoadBalancerTlsPoliciesResult
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
-
#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 (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_setup_history(params = {}) ⇒ Types::GetSetupHistoryResult
Returns detailed information for five of the most recent
SetupInstanceHttps
requests that were ran on the target instance. -
#get_static_ip(params = {}) ⇒ Types::GetStaticIpResult
Returns information about an Amazon Lightsail 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
Peers 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.
-
#set_resource_access_for_bucket(params = {}) ⇒ Types::SetResourceAccessForBucketResult
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
-
#setup_instance_https(params = {}) ⇒ Types::SetupInstanceHttpsResult
Creates an SSL/TLS certificate that secures traffic for your website.
-
#start_gui_session(params = {}) ⇒ Types::StartGUISessionResult
Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application.
-
#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_gui_session(params = {}) ⇒ Types::StopGUISessionResult
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application.
-
#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
Unpeers 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_bucket(params = {}) ⇒ Types::UpdateBucketResult
Updates an existing Amazon Lightsail bucket.
-
#update_bucket_bundle(params = {}) ⇒ Types::UpdateBucketBundleResult
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
-
#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_instance_metadata_options(params = {}) ⇒ Types::UpdateInstanceMetadataOptionsResult
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance.
-
#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.
395 396 397 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#allocate_static_ip(params = {}) ⇒ Types::AllocateStaticIpResult
Allocates a static IP address.
437 438 439 440 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 437 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
Amazon Web Services
Region can be attached to Lightsail distributions. Lightsail
distributions are global resources that can reference an origin in any
Amazon Web Services Region, and distribute its content globally.
However, all distributions are located in the us-east-1
Region.
512 513 514 515 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 512 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 Amazon Lightsail Developer Guide.
578 579 580 581 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 578 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
Developer Guide.
643 644 645 646 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 643 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 Amazon Lightsail
Developer Guide.
707 708 709 710 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 707 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.
752 753 754 755 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 752 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 Amazon Lightsail
Developer Guide.
812 813 814 815 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 812 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 Amazon Web Services 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.
940 941 942 943 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 940 def copy_snapshot(params = {}, = {}) req = build_request(:copy_snapshot, params) req.send_request() end |
#create_bucket(params = {}) ⇒ Types::CreateBucketResult
Creates 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 Guide.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1070 def create_bucket(params = {}, = {}) req = build_request(:create_bucket, params) req.send_request() end |
#create_bucket_access_key(params = {}) ⇒ Types::CreateBucketAccessKeyResult
Creates 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 GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
The secretAccessKey
value is returned only in response to the
CreateBucketAccessKey
action. You can get a secret access key only
when you first create an access key; you cannot get the secret access
key later. If you lose the secret access key, you must create a new
access key.
1140 1141 1142 1143 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1140 def create_bucket_access_key(params = {}, = {}) req = build_request(:create_bucket_access_key, 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
Amazon Web Services
Region can be attached to Lightsail distributions. Lightsail
distributions are global resources that can reference an origin in any
Amazon Web Services Region, and distribute its content globally.
However, all distributions are located in the us-east-1
Region.
1269 1270 1271 1272 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1269 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.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1329 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1428 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.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1667 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 such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
1805 1806 1807 1808 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1805 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.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1857 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 (us-east-2a
).
The create disk
operation supports tag-based access control via
request tags. For more information, see the Amazon Lightsail
Developer Guide.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 1947 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 (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
Amazon Lightsail Developer Guide.
2112 2113 2114 2115 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2112 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 Amazon Lightsail
Developer Guide.
2219 2220 2221 2222 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2219 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.
2414 2415 2416 2417 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2414 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 (example.com).
The create domain
operation supports tag-based access control via
request tags. For more information, see the Amazon Lightsail
Developer Guide.
2473 2474 2475 2476 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2473 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 Amazon Lightsail Developer Guide.
2539 2540 2541 2542 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2539 def create_domain_entry(params = {}, = {}) req = build_request(:create_domain_entry, params) req.send_request() end |
#create_gui_session_access_details(params = {}) ⇒ Types::CreateGUISessionAccessDetailsResult
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.
Use StartGUISession
to open the session.
2584 2585 2586 2587 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2584 def create_gui_session_access_details(params = {}, = {}) req = build_request(:create_gui_session_access_details, 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 Amazon
Lightsail Developer Guide.
2650 2651 2652 2653 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2650 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 Developer
Guide.
2797 2798 2799 2800 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 2797 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 Amazon Lightsail Developer Guide.
3006 3007 3008 3009 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3006 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 a custom SSH key pair that you can use with an Amazon Lightsail instance.
The create key pair
operation supports tag-based access control via
request tags. For more information, see the Amazon Lightsail
Developer Guide.
3089 3090 3091 3092 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3089 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 Amazon Lightsail
Developer Guide.
3217 3218 3219 3220 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3217 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 Amazon Lightsail
Developer Guide.
3307 3308 3309 3310 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3307 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 Amazon
Lightsail Developer Guide.
3567 3568 3569 3570 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3567 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 Amazon Lightsail Developer Guide.
3704 3705 3706 3707 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3704 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 Amazon
Lightsail Developer Guide.
3776 3777 3778 3779 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3776 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.
3826 3827 3828 3829 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3826 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 Amazon Lightsail Developer Guide.
3879 3880 3881 3882 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3879 def delete_auto_snapshot(params = {}, = {}) req = build_request(:delete_auto_snapshot, params) req.send_request() end |
#delete_bucket(params = {}) ⇒ Types::DeleteBucketResult
Deletes a Amazon Lightsail bucket.
3957 3958 3959 3960 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 3957 def delete_bucket(params = {}, = {}) req = build_request(:delete_bucket, params) req.send_request() end |
#delete_bucket_access_key(params = {}) ⇒ Types::DeleteBucketAccessKeyResult
Deletes 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.
4020 4021 4022 4023 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4020 def delete_bucket_access_key(params = {}, = {}) req = build_request(:delete_bucket_access_key, 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.
4069 4070 4071 4072 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4069 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
4129 4130 4131 4132 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4129 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.
4168 4169 4170 4171 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4168 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.
4190 4191 4192 4193 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4190 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 Amazon Lightsail Developer Guide.
4249 4250 4251 4252 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4249 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 Amazon Lightsail Developer
Guide.
4307 4308 4309 4310 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4307 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.
4351 4352 4353 4354 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4351 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 Amazon Lightsail Developer Guide.
4399 4400 4401 4402 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4399 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 Amazon Lightsail Developer Guide.
4461 4462 4463 4464 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4461 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 Amazon Lightsail Developer Guide.
4515 4516 4517 4518 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4515 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 Amazon
Lightsail Developer Guide.
4566 4567 4568 4569 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4566 def delete_instance_snapshot(params = {}, = {}) req = build_request(:delete_instance_snapshot, params) req.send_request() end |
#delete_key_pair(params = {}) ⇒ Types::DeleteKeyPairResult
Deletes 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 specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
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 Amazon Lightsail Developer Guide.
4633 4634 4635 4636 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4633 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.
4688 4689 4690 4691 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4688 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 Amazon Lightsail Developer
Guide.
4741 4742 4743 4744 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4741 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 Amazon Lightsail
Developer Guide.
4805 4806 4807 4808 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4805 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 Amazon
Lightsail Developer Guide.
4883 4884 4885 4886 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4883 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 Amazon
Lightsail Developer Guide.
4933 4934 4935 4936 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4933 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.
4981 4982 4983 4984 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 4981 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 Amazon Lightsail Developer Guide.
5033 5034 5035 5036 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5033 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 Amazon Lightsail
Developer Guide.
5091 5092 5093 5094 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5091 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.
5133 5134 5135 5136 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5133 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 Amazon Lightsail Developer Guide.
5183 5184 5185 5186 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5183 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 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.
5209 5210 5211 5212 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5209 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 Amazon Lightsail Developer Guide.
5269 5270 5271 5272 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5269 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 Amazon Lightsail Developer
Guide.
get instance snapshots
or get disk snapshots
operations to
get a list of snapshots that you can export to Amazon EC2.
5337 5338 5339 5340 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5337 def export_snapshot(params = {}, = {}) req = build_request(:export_snapshot, params) req.send_request() end |
#get_active_names(params = {}) ⇒ Types::GetActiveNamesResult
Returns the names of all active (not deleted) resources.
5372 5373 5374 5375 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5372 def get_active_names(params = {}, = {}) req = build_request(:get_active_names, params) req.send_request() end |
#get_alarms(params = {}) ⇒ Types::GetAlarmsResult
Returns 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 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.
5456 5457 5458 5459 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5456 def get_alarms(params = {}, = {}) req = build_request(:get_alarms, params) req.send_request() end |
#get_auto_snapshots(params = {}) ⇒ Types::GetAutoSnapshotsResult
Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
5500 5501 5502 5503 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5500 def get_auto_snapshots(params = {}, = {}) req = build_request(:get_auto_snapshots, params) req.send_request() end |
#get_blueprints(params = {}) ⇒ Types::GetBlueprintsResult
Returns 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.
5571 5572 5573 5574 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5571 def get_blueprints(params = {}, = {}) req = build_request(:get_blueprints, params) req.send_request() end |
#get_bucket_access_keys(params = {}) ⇒ Types::GetBucketAccessKeysResult
Returns 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, you must create a new access key.
5616 5617 5618 5619 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5616 def get_bucket_access_keys(params = {}, = {}) req = build_request(:get_bucket_access_keys, params) req.send_request() end |
#get_bucket_bundles(params = {}) ⇒ Types::GetBucketBundlesResult
Returns 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.
5661 5662 5663 5664 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5661 def get_bucket_bundles(params = {}, = {}) req = build_request(:get_bucket_bundles, params) req.send_request() end |
#get_bucket_metric_data(params = {}) ⇒ Types::GetBucketMetricDataResult
Returns 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.
5786 5787 5788 5789 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5786 def get_bucket_metric_data(params = {}, = {}) req = build_request(:get_bucket_metric_data, params) req.send_request() end |
#get_buckets(params = {}) ⇒ Types::GetBucketsResult
Returns 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 Amazon Lightsail in the Amazon Lightsail Developer Guide.
5878 5879 5880 5881 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5878 def get_buckets(params = {}, = {}) req = build_request(:get_buckets, params) req.send_request() end |
#get_bundles(params = {}) ⇒ Types::GetBundlesResult
Returns 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.
5947 5948 5949 5950 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 5947 def get_bundles(params = {}, = {}) req = build_request(:get_bundles, params) req.send_request() end |
#get_certificates(params = {}) ⇒ Types::GetCertificatesResult
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
includeCertificateDetails
from your request. The response will include only the certificate
Amazon Resource Name (ARN), certificate name, domain name, and tags.
6061 6062 6063 6064 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6061 def get_certificates(params = {}, = {}) req = build_request(:get_certificates, params) req.send_request() end |
#get_cloud_formation_stack_records(params = {}) ⇒ Types::GetCloudFormationStackRecordsResult
Returns 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.
6113 6114 6115 6116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6113 def get_cloud_formation_stack_records(params = {}, = {}) req = build_request(:get_cloud_formation_stack_records, params) req.send_request() end |
#get_contact_methods(params = {}) ⇒ Types::GetContactMethodsResult
Returns 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 contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
6169 6170 6171 6172 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6169 def get_contact_methods(params = {}, = {}) req = build_request(:get_contact_methods, params) req.send_request() end |
#get_container_api_metadata(params = {}) ⇒ Types::GetContainerAPIMetadataResult
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
6191 6192 6193 6194 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6191 def (params = {}, = {}) req = build_request(:get_container_api_metadata, params) req.send_request() end |
#get_container_images(params = {}) ⇒ Types::GetContainerImagesResult
Returns the container images that are registered to your Amazon Lightsail container service.
6231 6232 6233 6234 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6231 def get_container_images(params = {}, = {}) req = build_request(:get_container_images, params) req.send_request() end |
#get_container_log(params = {}) ⇒ Types::GetContainerLogResult
Returns 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.
6354 6355 6356 6357 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6354 def get_container_log(params = {}, = {}) req = build_request(:get_container_log, params) req.send_request() end |
#get_container_service_deployments(params = {}) ⇒ Types::GetContainerServiceDeploymentsResult
Returns 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 of the response.
6418 6419 6420 6421 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6418 def get_container_service_deployments(params = {}, = {}) req = build_request(:get_container_service_deployments, params) req.send_request() end |
#get_container_service_metric_data(params = {}) ⇒ Types::GetContainerServiceMetricDataResult
Returns 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.
6529 6530 6531 6532 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6529 def get_container_service_metric_data(params = {}, = {}) req = build_request(:get_container_service_metric_data, params) req.send_request() end |
#get_container_service_powers(params = {}) ⇒ Types::GetContainerServicePowersResult
Returns 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.
6558 6559 6560 6561 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6558 def get_container_service_powers(params = {}, = {}) req = build_request(:get_container_service_powers, params) req.send_request() end |
#get_container_services(params = {}) ⇒ Types::ContainerServicesListResult
Returns information about one or more of your Amazon Lightsail container services.
6652 6653 6654 6655 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6652 def get_container_services(params = {}, = {}) req = build_request(:get_container_services, params) req.send_request() end |
#get_cost_estimate(params = {}) ⇒ Types::GetCostEstimateResult
Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
6735 6736 6737 6738 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6735 def get_cost_estimate(params = {}, = {}) req = build_request(:get_cost_estimate, params) req.send_request() end |
#get_disk(params = {}) ⇒ Types::GetDiskResult
Returns information about a specific block storage disk.
6789 6790 6791 6792 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6789 def get_disk(params = {}, = {}) req = build_request(:get_disk, params) req.send_request() end |
#get_disk_snapshot(params = {}) ⇒ Types::GetDiskSnapshotResult
Returns information about a specific block storage disk snapshot.
6834 6835 6836 6837 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6834 def get_disk_snapshot(params = {}, = {}) req = build_request(:get_disk_snapshot, params) req.send_request() end |
#get_disk_snapshots(params = {}) ⇒ Types::GetDiskSnapshotsResult
Returns information about all block storage disk snapshots in your AWS account and region.
6887 6888 6889 6890 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6887 def get_disk_snapshots(params = {}, = {}) req = build_request(:get_disk_snapshots, params) req.send_request() end |
#get_disks(params = {}) ⇒ Types::GetDisksResult
Returns information about all block storage disks in your AWS account and region.
6949 6950 6951 6952 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6949 def get_disks(params = {}, = {}) req = build_request(:get_disks, params) req.send_request() end |
#get_distribution_bundles(params = {}) ⇒ Types::GetDistributionBundlesResult
Returns 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.
6977 6978 6979 6980 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 6977 def get_distribution_bundles(params = {}, = {}) req = build_request(:get_distribution_bundles, params) req.send_request() end |
#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.
7015 7016 7017 7018 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7015 def get_distribution_latest_cache_reset(params = {}, = {}) req = build_request(:get_distribution_latest_cache_reset, params) req.send_request() end |
#get_distribution_metric_data(params = {}) ⇒ Types::GetDistributionMetricDataResult
Returns 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 performance of your resources.
7199 7200 7201 7202 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7199 def get_distribution_metric_data(params = {}, = {}) req = build_request(:get_distribution_metric_data, params) req.send_request() end |
#get_distributions(params = {}) ⇒ Types::GetDistributionsResult
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
7285 7286 7287 7288 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7285 def get_distributions(params = {}, = {}) req = build_request(:get_distributions, params) req.send_request() end |
#get_domain(params = {}) ⇒ Types::GetDomainResult
Returns information about a specific domain recordset.
7334 7335 7336 7337 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7334 def get_domain(params = {}, = {}) req = build_request(:get_domain, params) req.send_request() end |
#get_domains(params = {}) ⇒ Types::GetDomainsResult
Returns a list of all domains in the user's account.
7390 7391 7392 7393 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7390 def get_domains(params = {}, = {}) req = build_request(:get_domains, params) req.send_request() end |
#get_export_snapshot_records(params = {}) ⇒ Types::GetExportSnapshotRecordsResult
Returns 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.
7457 7458 7459 7460 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7457 def get_export_snapshot_records(params = {}, = {}) req = build_request(:get_export_snapshot_records, params) req.send_request() end |
#get_instance(params = {}) ⇒ Types::GetInstanceResult
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
7565 7566 7567 7568 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7565 def get_instance(params = {}, = {}) req = build_request(:get_instance, params) req.send_request() end |
#get_instance_access_details(params = {}) ⇒ Types::GetInstanceAccessDetailsResult
Returns 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
Developer Guide.
7626 7627 7628 7629 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7626 def get_instance_access_details(params = {}, = {}) req = build_request(:get_instance_access_details, params) req.send_request() end |
#get_instance_metric_data(params = {}) ⇒ Types::GetInstanceMetricDataResult
Returns 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 resources.
7838 7839 7840 7841 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7838 def get_instance_metric_data(params = {}, = {}) req = build_request(:get_instance_metric_data, params) req.send_request() end |
#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.
7878 7879 7880 7881 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7878 def get_instance_port_states(params = {}, = {}) req = build_request(:get_instance_port_states, params) req.send_request() end |
#get_instance_snapshot(params = {}) ⇒ Types::GetInstanceSnapshotResult
Returns information about a specific instance snapshot.
7951 7952 7953 7954 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 7951 def get_instance_snapshot(params = {}, = {}) req = build_request(:get_instance_snapshot, params) req.send_request() end |
#get_instance_snapshots(params = {}) ⇒ Types::GetInstanceSnapshotsResult
Returns all instance snapshots for the user's account.
8032 8033 8034 8035 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8032 def get_instance_snapshots(params = {}, = {}) req = build_request(:get_instance_snapshots, params) req.send_request() end |
#get_instance_state(params = {}) ⇒ Types::GetInstanceStateResult
Returns the state of a specific instance. Works on one instance at a time.
8062 8063 8064 8065 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8062 def get_instance_state(params = {}, = {}) req = build_request(:get_instance_state, params) req.send_request() end |
#get_instances(params = {}) ⇒ Types::GetInstancesResult
Returns information about all Amazon Lightsail virtual private servers, or instances.
8177 8178 8179 8180 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8177 def get_instances(params = {}, = {}) req = build_request(:get_instances, params) req.send_request() end |
#get_key_pair(params = {}) ⇒ Types::GetKeyPairResult
Returns information about a specific key pair.
8215 8216 8217 8218 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8215 def get_key_pair(params = {}, = {}) req = build_request(:get_key_pair, params) req.send_request() end |
#get_key_pairs(params = {}) ⇒ Types::GetKeyPairsResult
Returns information about all key pairs in the user's account.
8265 8266 8267 8268 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8265 def get_key_pairs(params = {}, = {}) req = build_request(:get_key_pairs, params) req.send_request() end |
#get_load_balancer(params = {}) ⇒ Types::GetLoadBalancerResult
Returns information about the specified Lightsail load balancer.
8321 8322 8323 8324 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8321 def get_load_balancer(params = {}, = {}) req = build_request(:get_load_balancer, params) req.send_request() end |
#get_load_balancer_metric_data(params = {}) ⇒ Types::GetLoadBalancerMetricDataResult
Returns 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.
8528 8529 8530 8531 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8528 def get_load_balancer_metric_data(params = {}, = {}) req = build_request(:get_load_balancer_metric_data, params) req.send_request() end |
#get_load_balancer_tls_certificates(params = {}) ⇒ Types::GetLoadBalancerTlsCertificatesResult
Returns 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 inactive.
8603 8604 8605 8606 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8603 def get_load_balancer_tls_certificates(params = {}, = {}) req = build_request(:get_load_balancer_tls_certificates, params) req.send_request() end |
#get_load_balancer_tls_policies(params = {}) ⇒ Types::GetLoadBalancerTlsPoliciesResult
Returns 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.
8654 8655 8656 8657 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8654 def get_load_balancer_tls_policies(params = {}, = {}) req = build_request(:get_load_balancer_tls_policies, params) req.send_request() end |
#get_load_balancers(params = {}) ⇒ Types::GetLoadBalancersResult
Returns information about all load balancers in an account.
8717 8718 8719 8720 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8717 def get_load_balancers(params = {}, = {}) req = build_request(:get_load_balancers, params) req.send_request() end |
#get_operation(params = {}) ⇒ Types::GetOperationResult
Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
8759 8760 8761 8762 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8759 def get_operation(params = {}, = {}) req = build_request(:get_operation, params) req.send_request() end |
#get_operations(params = {}) ⇒ Types::GetOperationsResult
Returns 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.
8811 8812 8813 8814 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8811 def get_operations(params = {}, = {}) req = build_request(:get_operations, params) req.send_request() end |
#get_operations_for_resource(params = {}) ⇒ Types::GetOperationsForResourceResult
Gets operations for a specific resource (an instance or a static IP).
8865 8866 8867 8868 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8865 def get_operations_for_resource(params = {}, = {}) req = build_request(:get_operations_for_resource, params) req.send_request() end |
#get_regions(params = {}) ⇒ Types::GetRegionsResult
Returns a list of all valid regions for Amazon Lightsail. Use the
include availability zones
parameter to also return the Availability
Zones in a region.
8913 8914 8915 8916 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8913 def get_regions(params = {}, = {}) req = build_request(:get_regions, params) req.send_request() end |
#get_relational_database(params = {}) ⇒ Types::GetRelationalDatabaseResult
Returns information about a specific database in Amazon Lightsail.
8977 8978 8979 8980 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 8977 def get_relational_database(params = {}, = {}) req = build_request(:get_relational_database, params) req.send_request() end |
#get_relational_database_blueprints(params = {}) ⇒ Types::GetRelationalDatabaseBlueprintsResult
Returns 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.
9022 9023 9024 9025 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9022 def get_relational_database_blueprints(params = {}, = {}) req = build_request(:get_relational_database_blueprints, params) req.send_request() end |
#get_relational_database_bundles(params = {}) ⇒ Types::GetRelationalDatabaseBundlesResult
Returns 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.
9075 9076 9077 9078 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9075 def get_relational_database_bundles(params = {}, = {}) req = build_request(:get_relational_database_bundles, params) req.send_request() end |
#get_relational_database_events(params = {}) ⇒ Types::GetRelationalDatabaseEventsResult
Returns a list of events for a specific database in Amazon Lightsail.
9128 9129 9130 9131 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9128 def get_relational_database_events(params = {}, = {}) req = build_request(:get_relational_database_events, params) req.send_request() end |
#get_relational_database_log_events(params = {}) ⇒ Types::GetRelationalDatabaseLogEventsResult
Returns a list of log events for a database in Amazon Lightsail.
9217 9218 9219 9220 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9217 def get_relational_database_log_events(params = {}, = {}) req = build_request(:get_relational_database_log_events, params) req.send_request() end |
#get_relational_database_log_streams(params = {}) ⇒ Types::GetRelationalDatabaseLogStreamsResult
Returns a list of available log streams for a specific database in Amazon Lightsail.
9247 9248 9249 9250 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9247 def get_relational_database_log_streams(params = {}, = {}) req = build_request(:get_relational_database_log_streams, params) req.send_request() end |
#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.
The GetRelationalDatabaseMasterUserPassword
operation supports
tag-based access control via resource tags applied to the resource
identified by relationalDatabaseName.
9294 9295 9296 9297 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9294 def get_relational_database_master_user_password(params = {}, = {}) req = build_request(:get_relational_database_master_user_password, params) req.send_request() end |
#get_relational_database_metric_data(params = {}) ⇒ Types::GetRelationalDatabaseMetricDataResult
Returns 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.
9460 9461 9462 9463 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9460 def get_relational_database_metric_data(params = {}, = {}) req = build_request(:get_relational_database_metric_data, params) req.send_request() end |
#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.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
9514 9515 9516 9517 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9514 def get_relational_database_parameters(params = {}, = {}) req = build_request(:get_relational_database_parameters, params) req.send_request() end |
#get_relational_database_snapshot(params = {}) ⇒ Types::GetRelationalDatabaseSnapshotResult
Returns information about a specific database snapshot in Amazon Lightsail.
9560 9561 9562 9563 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9560 def get_relational_database_snapshot(params = {}, = {}) req = build_request(:get_relational_database_snapshot, params) req.send_request() end |
#get_relational_database_snapshots(params = {}) ⇒ Types::GetRelationalDatabaseSnapshotsResult
Returns information about all of your database snapshots in Amazon Lightsail.
9614 9615 9616 9617 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9614 def get_relational_database_snapshots(params = {}, = {}) req = build_request(:get_relational_database_snapshots, params) req.send_request() end |
#get_relational_databases(params = {}) ⇒ Types::GetRelationalDatabasesResult
Returns information about all of your databases in Amazon Lightsail.
9686 9687 9688 9689 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9686 def get_relational_databases(params = {}, = {}) req = build_request(:get_relational_databases, params) req.send_request() end |
#get_setup_history(params = {}) ⇒ Types::GetSetupHistoryResult
Returns detailed information for five of the most recent
SetupInstanceHttps
requests that were ran on the target instance.
9745 9746 9747 9748 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9745 def get_setup_history(params = {}, = {}) req = build_request(:get_setup_history, params) req.send_request() end |
#get_static_ip(params = {}) ⇒ Types::GetStaticIpResult
Returns information about an Amazon Lightsail static IP.
9782 9783 9784 9785 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9782 def get_static_ip(params = {}, = {}) req = build_request(:get_static_ip, params) req.send_request() end |
#get_static_ips(params = {}) ⇒ Types::GetStaticIpsResult
Returns information about all static IPs in the user's account.
9826 9827 9828 9829 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9826 def get_static_ips(params = {}, = {}) req = build_request(:get_static_ips, params) req.send_request() end |
#import_key_pair(params = {}) ⇒ Types::ImportKeyPairResult
Imports a public SSH key from a specific key pair.
9870 9871 9872 9873 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9870 def import_key_pair(params = {}, = {}) req = build_request(:import_key_pair, params) req.send_request() end |
#is_vpc_peered(params = {}) ⇒ Types::IsVpcPeeredResult
Returns a Boolean value indicating whether your Lightsail VPC is peered.
9890 9891 9892 9893 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9890 def is_vpc_peered(params = {}, = {}) req = build_request(:is_vpc_peered, params) req.send_request() end |
#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.
The OpenInstancePublicPorts
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.
9952 9953 9954 9955 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9952 def open_instance_public_ports(params = {}, = {}) req = build_request(:open_instance_public_ports, params) req.send_request() end |
#peer_vpc(params = {}) ⇒ Types::PeerVpcResult
Peers the Lightsail VPC with the user's default VPC.
9983 9984 9985 9986 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 9983 def peer_vpc(params = {}, = {}) req = build_request(:peer_vpc, params) req.send_request() end |
#put_alarm(params = {}) ⇒ Types::PutAlarmResult
Creates 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 information, see Alarms in Amazon Lightsail.
When this action creates an alarm, the alarm state is immediately set
to INSUFFICIENT_DATA
. The alarm is then evaluated and its state is
set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
10190 10191 10192 10193 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10190 def put_alarm(params = {}, = {}) req = build_request(:put_alarm, params) req.send_request() end |
#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. 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 open in your PutInstancePublicPorts
request. Or
use the OpenInstancePublicPorts
action to open ports without closing
currently open ports.
The PutInstancePublicPorts
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.
10259 10260 10261 10262 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10259 def put_instance_public_ports(params = {}, = {}) req = build_request(:put_instance_public_ports, params) req.send_request() end |
#reboot_instance(params = {}) ⇒ Types::RebootInstanceResult
Restarts 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.
10308 10309 10310 10311 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10308 def reboot_instance(params = {}, = {}) req = build_request(:reboot_instance, params) req.send_request() end |
#reboot_relational_database(params = {}) ⇒ Types::RebootRelationalDatabaseResult
Restarts 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.
10358 10359 10360 10361 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10358 def reboot_relational_database(params = {}, = {}) req = build_request(:reboot_relational_database, params) req.send_request() end |
#register_container_image(params = {}) ⇒ Types::RegisterContainerImageResult
Registers a container image to your Amazon Lightsail container service.
10434 10435 10436 10437 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10434 def register_container_image(params = {}, = {}) req = build_request(:register_container_image, params) req.send_request() end |
#release_static_ip(params = {}) ⇒ Types::ReleaseStaticIpResult
Deletes a specific static IP from your account.
10475 10476 10477 10478 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10475 def release_static_ip(params = {}, = {}) req = build_request(:release_static_ip, params) req.send_request() end |
#reset_distribution_cache(params = {}) ⇒ Types::ResetDistributionCacheResult
Deletes 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.
10526 10527 10528 10529 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10526 def reset_distribution_cache(params = {}, = {}) req = build_request(:reset_distribution_cache, params) req.send_request() end |
#send_contact_method_verification(params = {}) ⇒ Types::SendContactMethodVerificationResult
Sends 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 method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
10589 10590 10591 10592 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10589 def send_contact_method_verification(params = {}, = {}) req = build_request(:send_contact_method_verification, params) req.send_request() end |
#set_ip_address_type(params = {}) ⇒ Types::SetIpAddressTypeResult
Sets 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.
10655 10656 10657 10658 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10655 def set_ip_address_type(params = {}, = {}) req = build_request(:set_ip_address_type, params) req.send_request() end |
#set_resource_access_for_bucket(params = {}) ⇒ Types::SetResourceAccessForBucketResult
Sets 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.
10717 10718 10719 10720 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10717 def set_resource_access_for_bucket(params = {}, = {}) req = build_request(:set_resource_access_for_bucket, params) req.send_request() end |
#setup_instance_https(params = {}) ⇒ Types::SetupInstanceHttpsResult
Creates 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.
10777 10778 10779 10780 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10777 def setup_instance_https(params = {}, = {}) req = build_request(:setup_instance_https, params) req.send_request() end |
#start_gui_session(params = {}) ⇒ Types::StartGUISessionResult
Initiates 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.
10821 10822 10823 10824 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10821 def start_gui_session(params = {}, = {}) req = build_request(:start_gui_session, params) req.send_request() end |
#start_instance(params = {}) ⇒ Types::StartInstanceResult
Starts a specific Amazon Lightsail instance from a stopped state. To
restart an instance, use the reboot instance
operation.
The start 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.
10880 10881 10882 10883 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10880 def start_instance(params = {}, = {}) req = build_request(:start_instance, params) req.send_request() end |
#start_relational_database(params = {}) ⇒ Types::StartRelationalDatabaseResult
Starts 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 information, see the Amazon
Lightsail Developer Guide.
10931 10932 10933 10934 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10931 def start_relational_database(params = {}, = {}) req = build_request(:start_relational_database, params) req.send_request() end |
#stop_gui_session(params = {}) ⇒ Types::StopGUISessionResult
Terminates a web-based NICE 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.
10974 10975 10976 10977 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 10974 def stop_gui_session(params = {}, = {}) req = build_request(:stop_gui_session, params) req.send_request() end |
#stop_instance(params = {}) ⇒ Types::StopInstanceResult
Stops a specific Amazon Lightsail instance that is currently running.
The stop 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.
11041 11042 11043 11044 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11041 def stop_instance(params = {}, = {}) req = build_request(:stop_instance, params) req.send_request() end |
#stop_relational_database(params = {}) ⇒ Types::StopRelationalDatabaseResult
Stops a specific database that is currently running in Amazon Lightsail.
The stop 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.
11097 11098 11099 11100 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11097 def stop_relational_database(params = {}, = {}) req = build_request(:stop_relational_database, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceResult
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.
The tag 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
Developer Guide.
11165 11166 11167 11168 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11165 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_alarm(params = {}) ⇒ Types::TestAlarmResult
Tests 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 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.
11232 11233 11234 11235 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11232 def test_alarm(params = {}, = {}) req = build_request(:test_alarm, params) req.send_request() end |
#unpeer_vpc(params = {}) ⇒ Types::UnpeerVpcResult
Unpeers the Lightsail VPC from the user's default VPC.
11263 11264 11265 11266 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11263 def unpeer_vpc(params = {}, = {}) req = build_request(:unpeer_vpc, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Types::UntagResourceResult
Deletes 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
Developer Guide.
11323 11324 11325 11326 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11323 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_bucket(params = {}) ⇒ Types::UpdateBucketResult
Updates 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.
11431 11432 11433 11434 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11431 def update_bucket(params = {}, = {}) req = build_request(:update_bucket, params) req.send_request() end |
#update_bucket_bundle(params = {}) ⇒ Types::UpdateBucketBundleResult
Updates 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 update a bucket's bundle, use the
GetBuckets action. The ableToUpdateBundle
parameter in the
response will indicate whether you can currently update a bucket's
bundle.
Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
11505 11506 11507 11508 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11505 def update_bucket_bundle(params = {}, = {}) req = build_request(:update_bucket_bundle, params) req.send_request() end |
#update_container_service(params = {}) ⇒ Types::UpdateContainerServiceResult
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
11663 11664 11665 11666 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11663 def update_container_service(params = {}, = {}) req = build_request(:update_container_service, params) req.send_request() end |
#update_distribution(params = {}) ⇒ Types::UpdateDistributionResult
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
11802 11803 11804 11805 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11802 def update_distribution(params = {}, = {}) req = build_request(:update_distribution, params) req.send_request() end |
#update_distribution_bundle(params = {}) ⇒ Types::UpdateDistributionBundleResult
Updates 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 and is incurring an overage fee.
You can update your distribution's bundle only one time within your
monthly Amazon Web Services billing cycle. To determine if you can
update your distribution's bundle, use the GetDistributions
action.
The ableToUpdateBundle
parameter in the result will indicate whether
you can currently update your distribution's bundle.
11865 11866 11867 11868 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11865 def update_distribution_bundle(params = {}, = {}) req = build_request(:update_distribution_bundle, params) req.send_request() end |
#update_domain_entry(params = {}) ⇒ Types::UpdateDomainEntryResult
Updates 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.
11928 11929 11930 11931 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 11928 def update_domain_entry(params = {}, = {}) req = build_request(:update_domain_entry, params) req.send_request() end |
#update_instance_metadata_options(params = {}) ⇒ Types::UpdateInstanceMetadataOptionsResult
Modifies 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 state changes to applied
in subsequent GetInstance
or GetInstances
API calls. For more
information, see Use IMDSv2 with an Amazon Lightsail instance in
the Amazon Lightsail Developer Guide.
12023 12024 12025 12026 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 12023 def (params = {}, = {}) req = build_request(:update_instance_metadata_options, params) req.send_request() end |
#update_load_balancer_attribute(params = {}) ⇒ Types::UpdateLoadBalancerAttributeResult
Updates 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
Developer Guide.
12116 12117 12118 12119 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 12116 def update_load_balancer_attribute(params = {}, = {}) req = build_request(:update_load_balancer_attribute, params) req.send_request() end |
#update_relational_database(params = {}) ⇒ Types::UpdateRelationalDatabaseResult
Allows 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
control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Amazon
Lightsail Developer Guide.
12282 12283 12284 12285 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 12282 def update_relational_database(params = {}, = {}) req = build_request(:update_relational_database, params) req.send_request() end |
#update_relational_database_parameters(params = {}) ⇒ Types::UpdateRelationalDatabaseParametersResult
Allows 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
. Parameters marked with a dynamic
apply type are
applied immediately. Parameters marked with a pending-reboot
apply
type are applied only after the database is rebooted using the reboot
relational database
operation.
The update relational database parameters
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.
12356 12357 12358 12359 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb', line 12356 def update_relational_database_parameters(params = {}, = {}) req = build_request(:update_relational_database_parameters, params) req.send_request() end |