pub struct Client { /* private fields */ }
Expand description

Client for Amazon Lightsail

Client for invoking operations on Amazon Lightsail. Each operation on Amazon Lightsail is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_lightsail::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_lightsail::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_lightsail::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AllocateStaticIp operation.

Constructs a fluent builder for the AttachCertificateToDistribution operation.

Constructs a fluent builder for the AttachDisk operation.

Constructs a fluent builder for the AttachInstancesToLoadBalancer operation.

Constructs a fluent builder for the AttachLoadBalancerTlsCertificate operation.

Constructs a fluent builder for the AttachStaticIp operation.

Constructs a fluent builder for the CloseInstancePublicPorts operation.

Constructs a fluent builder for the CopySnapshot operation.

Constructs a fluent builder for the CreateBucket operation.

Constructs a fluent builder for the CreateBucketAccessKey operation.

Constructs a fluent builder for the CreateCertificate operation.

Constructs a fluent builder for the CreateCloudFormationStack operation.

Constructs a fluent builder for the CreateContactMethod operation.

  • The fluent builder is configurable:
    • protocol(ContactProtocol) / set_protocol(Option<ContactProtocol>):

      The protocol of the contact method, such as Email or SMS (text messaging).

      The SMS protocol is supported only in the following Amazon Web Services Regions.

      • US East (N. Virginia) (us-east-1)

      • US West (Oregon) (us-west-2)

      • Europe (Ireland) (eu-west-1)

      • Asia Pacific (Tokyo) (ap-northeast-1)

      • Asia Pacific (Singapore) (ap-southeast-1)

      • Asia Pacific (Sydney) (ap-southeast-2)

      For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

      For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

    • contact_endpoint(impl Into<String>) / set_contact_endpoint(Option<String>):

      The destination of the contact method, such as an email address or a mobile phone number.

      Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.

  • On success, responds with CreateContactMethodOutput with field(s):
    • operations(Option<Vec<Operation>>):

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • On failure, responds with SdkError<CreateContactMethodError>

Constructs a fluent builder for the CreateContainerService operation.

  • The fluent builder is configurable:
    • service_name(impl Into<String>) / set_service_name(Option<String>):

      The name for the container service.

      The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https:// . . .cs.amazonlightsail.com . If the name of your container service is container-service-1, and it’s located in the US East (Ohio) AWS region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

      The following are the requirements for container service names:

      • Must be unique within each Amazon Web Services Region in your Lightsail account.

      • Must contain 1 to 63 characters.

      • Must contain only alphanumeric characters and hyphens.

      • A hyphen (-) can separate words but cannot be at the start or end of the name.

    • power(ContainerServicePowerName) / set_power(Option<ContainerServicePowerName>):

      The power specification for the container service.

      The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

      Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

    • scale(i32) / set_scale(Option<i32>):

      The scale specification for the container service.

      The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      The tag keys and optional values to add to the container service during create.

      Use the TagResource action to tag a resource after it’s created.

      For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

    • public_domain_names(HashMap<String, Vec<String>>) / set_public_domain_names(Option<HashMap<String, Vec<String>>>):

      The public domain names to use with the container service, such as example.com and www.example.com.

      You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

      If you don’t specify public domain names, then you can use the default domain of the container service.

      You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

      You can specify public domain names using a string to array map as shown in the example later on this page.

    • deployment(ContainerServiceDeploymentRequest) / set_deployment(Option<ContainerServiceDeploymentRequest>):

      An object that describes a deployment for the 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.

  • On success, responds with CreateContainerServiceOutput with field(s):
  • On failure, responds with SdkError<CreateContainerServiceError>

Constructs a fluent builder for the CreateContainerServiceDeployment operation.

Constructs a fluent builder for the CreateContainerServiceRegistryLogin operation.

Constructs a fluent builder for the CreateDisk operation.

Constructs a fluent builder for the CreateDiskFromSnapshot operation.

Constructs a fluent builder for the CreateDiskSnapshot operation.

Constructs a fluent builder for the CreateDistribution operation.

Constructs a fluent builder for the CreateDomain operation.

  • The fluent builder is configurable:
    • domain_name(impl Into<String>) / set_domain_name(Option<String>):

      The domain name to manage (e.g., example.com).

      You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain using Lightsail.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      The tag keys and optional values to add to the resource during create.

      Use the TagResource action to tag a resource after it’s created.

  • On success, responds with CreateDomainOutput with field(s):
    • operation(Option<Operation>):

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • On failure, responds with SdkError<CreateDomainError>
source

pub fn create_domain_entry(&self) -> CreateDomainEntry

Constructs a fluent builder for the CreateDomainEntry operation.

Constructs a fluent builder for the CreateInstances operation.

Constructs a fluent builder for the CreateInstancesFromSnapshot operation.

Constructs a fluent builder for the CreateInstanceSnapshot operation.

Constructs a fluent builder for the CreateKeyPair operation.

Constructs a fluent builder for the CreateLoadBalancer operation.

Constructs a fluent builder for the CreateLoadBalancerTlsCertificate operation.

Constructs a fluent builder for the CreateRelationalDatabase operation.

  • The fluent builder is configurable:
    • relational_database_name(impl Into<String>) / set_relational_database_name(Option<String>):

      The name to use for your new Lightsail database resource.

      Constraints:

      • Must contain from 2 to 255 alphanumeric characters, or hyphens.

      • The first and last character must be a letter or number.

    • availability_zone(impl Into<String>) / set_availability_zone(Option<String>):

      The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

      You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

    • relational_database_blueprint_id(impl Into<String>) / set_relational_database_blueprint_id(Option<String>):

      The blueprint ID for your new database. A blueprint describes the major engine version of a database.

      You can get a list of database blueprints IDs by using the get relational database blueprints operation.

    • relational_database_bundle_id(impl Into<String>) / set_relational_database_bundle_id(Option<String>):

      The bundle ID for your new database. A bundle describes the performance specifications for your database.

      You can get a list of database bundle IDs by using the get relational database bundles operation.

    • master_database_name(impl Into<String>) / set_master_database_name(Option<String>):

      The meaning of this parameter differs according to the database engine you use.

      MySQL

      The name of the database to create when the Lightsail database resource is created. If this parameter isn’t specified, no database is created in the database resource.

      Constraints:

      • Must contain 1 to 64 letters or numbers.

      • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

      • Can’t be a word reserved by the specified database engine.

        For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0.

      PostgreSQL

      The name of the database to create when the Lightsail database resource is created. If this parameter isn’t specified, a database named postgres is created in the database resource.

      Constraints:

      • Must contain 1 to 63 letters or numbers.

      • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9).

      • Can’t be a word reserved by the specified database engine.

        For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

    • master_username(impl Into<String>) / set_master_username(Option<String>):

      The name for the master user.

      MySQL

      Constraints:

      • Required for MySQL.

      • Must be 1 to 16 letters or numbers. Can contain underscores.

      • First character must be a letter.

      • Can’t be a reserved word for the chosen database engine.

        For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0.

      PostgreSQL

      Constraints:

      • Required for PostgreSQL.

      • Must be 1 to 63 letters or numbers. Can contain underscores.

      • First character must be a letter.

      • Can’t be a reserved word for the chosen database engine.

        For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12.

    • master_user_password(impl Into<String>) / set_master_user_password(Option<String>):

      The password for the master user. The password can include any printable ASCII character except “/”, “”“, or “@”. It cannot contain spaces.

      MySQL

      Constraints: Must contain from 8 to 41 characters.

      PostgreSQL

      Constraints: Must contain from 8 to 128 characters.

    • preferred_backup_window(impl Into<String>) / set_preferred_backup_window(Option<String>):

      The daily time range during which automated backups are created for your new database if automated backups are enabled.

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

      Constraints:

      • Must be in the hh24:mi-hh24:mi format.

        Example: 16:00-16:30

      • Specified in Coordinated Universal Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

    • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):

      The weekly time range during which system maintenance can occur on your new database.

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

      Constraints:

      • Must be in the ddd:hh24:mi-ddd:hh24:mi format.

      • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      • Must be at least 30 minutes.

      • Specified in Coordinated Universal Time (UTC).

      • Example: Tue:17:00-Tue:17:30

    • publicly_accessible(bool) / set_publicly_accessible(Option<bool>):

      Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

    • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      The tag keys and optional values to add to the resource during create.

      Use the TagResource action to tag a resource after it’s created.

  • On success, responds with CreateRelationalDatabaseOutput with field(s):
    • operations(Option<Vec<Operation>>):

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • On failure, responds with SdkError<CreateRelationalDatabaseError>

Constructs a fluent builder for the CreateRelationalDatabaseFromSnapshot operation.

Constructs a fluent builder for the CreateRelationalDatabaseSnapshot operation.

Constructs a fluent builder for the DeleteAlarm operation.

Constructs a fluent builder for the DeleteAutoSnapshot operation.

Constructs a fluent builder for the DeleteBucket operation.

Constructs a fluent builder for the DeleteBucketAccessKey operation.

Constructs a fluent builder for the DeleteCertificate operation.

Constructs a fluent builder for the DeleteContactMethod operation.

Constructs a fluent builder for the DeleteContainerImage operation.

Constructs a fluent builder for the DeleteContainerService operation.

Constructs a fluent builder for the DeleteDisk operation.

Constructs a fluent builder for the DeleteDiskSnapshot operation.

Constructs a fluent builder for the DeleteDistribution operation.

Constructs a fluent builder for the DeleteDomain operation.

source

pub fn delete_domain_entry(&self) -> DeleteDomainEntry

Constructs a fluent builder for the DeleteDomainEntry operation.

Constructs a fluent builder for the DeleteInstance operation.

Constructs a fluent builder for the DeleteInstanceSnapshot operation.

Constructs a fluent builder for the DeleteKeyPair operation.

Constructs a fluent builder for the DeleteKnownHostKeys operation.

Constructs a fluent builder for the DeleteLoadBalancer operation.

Constructs a fluent builder for the DeleteLoadBalancerTlsCertificate operation.

Constructs a fluent builder for the DeleteRelationalDatabase operation.

Constructs a fluent builder for the DeleteRelationalDatabaseSnapshot operation.

Constructs a fluent builder for the DetachCertificateFromDistribution operation.

Constructs a fluent builder for the DetachDisk operation.

Constructs a fluent builder for the DetachInstancesFromLoadBalancer operation.

Constructs a fluent builder for the DetachStaticIp operation.

Constructs a fluent builder for the DisableAddOn operation.

Constructs a fluent builder for the DownloadDefaultKeyPair operation.

Constructs a fluent builder for the EnableAddOn operation.

Constructs a fluent builder for the ExportSnapshot operation.

Constructs a fluent builder for the GetActiveNames operation.

  • The fluent builder is configurable:
    • page_token(impl Into<String>) / set_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetActiveNames request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • On success, responds with GetActiveNamesOutput with field(s):
    • active_names(Option<Vec<String>>):

      The list of active names returned by the get active names request.

    • next_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetActiveNames request and specify the next page token using the pageToken parameter.

  • On failure, responds with SdkError<GetActiveNamesError>

Constructs a fluent builder for the GetAlarms operation.

Constructs a fluent builder for the GetAutoSnapshots operation.

Constructs a fluent builder for the GetBlueprints operation.

Constructs a fluent builder for the GetBucketAccessKeys operation.

Constructs a fluent builder for the GetBucketBundles operation.

Constructs a fluent builder for the GetBucketMetricData operation.

  • The fluent builder is configurable:
    • bucket_name(impl Into<String>) / set_bucket_name(Option<String>):

      The name of the bucket for which to get metric data.

    • metric_name(BucketMetricName) / set_metric_name(Option<BucketMetricName>):

      The metric for which you want to return information.

      Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      These bucket metrics are reported once per day.

      • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

        Statistics: The most useful statistic is Maximum.

        Unit: The published unit is Bytes.

      • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Count.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The timestamp indicating the earliest data to be returned.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The timestamp indicating the latest data to be returned.

    • period(i32) / set_period(i32):

      The granularity, in seconds, of the returned data points.

      Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.

    • statistics(Vec<MetricStatistic>) / set_statistics(Option<Vec<MetricStatistic>>):

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

    • unit(MetricUnit) / set_unit(Option<MetricUnit>):

      The unit for the metric data request.

      Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

  • On success, responds with GetBucketMetricDataOutput with field(s):
  • On failure, responds with SdkError<GetBucketMetricDataError>

Constructs a fluent builder for the GetBuckets operation.

Constructs a fluent builder for the GetBundles operation.

Constructs a fluent builder for the GetCertificates operation.

Constructs a fluent builder for the GetCloudFormationStackRecords operation.

Constructs a fluent builder for the GetContactMethods operation.

Constructs a fluent builder for the GetContainerAPIMetadata operation.

Constructs a fluent builder for the GetContainerImages operation.

Constructs a fluent builder for the GetContainerLog operation.

  • The fluent builder is configurable:
    • service_name(impl Into<String>) / set_service_name(Option<String>):

      The name of the container service for which to get a container log.

    • container_name(impl Into<String>) / set_container_name(Option<String>):

      The name of the container that is either running or previously ran on the container service for which to return a log.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The start of the time interval for which to get log data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

      You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The end of the time interval for which to get log data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

      You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

    • filter_pattern(impl Into<String>) / set_filter_pattern(Option<String>):

      The pattern to use to filter the returned log events to a specific term.

      The following are a few examples of filter patterns that you can specify:

      • To return all log events, specify a filter pattern of “”.

      • To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of “-ERROR”.

      • To return log events that contain the ERROR term, specify a filter pattern of “ERROR”.

      • To return log events that contain both the ERROR and Exception terms, specify a filter pattern of “ERROR Exception”.

      • To return log events that contain the ERROR or the Exception term, specify a filter pattern of “?ERROR ?Exception”.

    • page_token(impl Into<String>) / set_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • On success, responds with GetContainerLogOutput with field(s):
    • log_events(Option<Vec<ContainerServiceLogEvent>>):

      An array of objects that describe the log events of a container.

    • next_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetContainerLog request and specify the next page token using the pageToken parameter.

  • On failure, responds with SdkError<GetContainerLogError>

Constructs a fluent builder for the GetContainerServiceDeployments operation.

Constructs a fluent builder for the GetContainerServiceMetricData operation.

  • The fluent builder is configurable:
    • service_name(impl Into<String>) / set_service_name(Option<String>):

      The name of the container service for which to get metric data.

    • metric_name(ContainerServiceMetricName) / set_metric_name(Option<ContainerServiceMetricName>):

      The metric for which you want to return information.

      Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The start time of the time period.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The end time of the time period.

    • period(i32) / set_period(i32):

      The granularity, in seconds, of the returned data points.

      All container service metric data is available in 5-minute (300 seconds) granularity.

    • statistics(Vec<MetricStatistic>) / set_statistics(Option<Vec<MetricStatistic>>):

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

  • On success, responds with GetContainerServiceMetricDataOutput with field(s):
  • On failure, responds with SdkError<GetContainerServiceMetricDataError>

Constructs a fluent builder for the GetContainerServicePowers operation.

Constructs a fluent builder for the GetContainerServices operation.

Constructs a fluent builder for the GetDisk operation.

Constructs a fluent builder for the GetDisks operation.

  • The fluent builder is configurable:
    • page_token(impl Into<String>) / set_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • On success, responds with GetDisksOutput with field(s):
    • disks(Option<Vec<Disk>>):

      An array of objects containing information about all block storage disks.

    • next_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.

  • On failure, responds with SdkError<GetDisksError>

Constructs a fluent builder for the GetDiskSnapshot operation.

Constructs a fluent builder for the GetDiskSnapshots operation.

  • The fluent builder is configurable:
    • page_token(impl Into<String>) / set_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetDiskSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • On success, responds with GetDiskSnapshotsOutput with field(s):
    • disk_snapshots(Option<Vec<DiskSnapshot>>):

      An array of objects containing information about all block storage disk snapshots.

    • next_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetDiskSnapshots request and specify the next page token using the pageToken parameter.

  • On failure, responds with SdkError<GetDiskSnapshotsError>

Constructs a fluent builder for the GetDistributionBundles operation.

Constructs a fluent builder for the GetDistributionLatestCacheReset operation.

Constructs a fluent builder for the GetDistributionMetricData operation.

  • The fluent builder is configurable:
    • distribution_name(impl Into<String>) / set_distribution_name(Option<String>):

      The name of the distribution for which to get metric data.

      Use the GetDistributions action to get a list of distribution names that you can specify.

    • metric_name(DistributionMetricName) / set_metric_name(Option<DistributionMetricName>):

      The metric for which you want to return information.

      Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is None.

      • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is None.

      • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is None.

      • TotalErrorRate - The percentage of all viewer requests for which the response’s HTTP status code was 4xx or 5xx.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Percent.

      • 4xxErrorRate - The percentage of all viewer requests for which the response’s HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Percent.

      • 5xxErrorRate - The percentage of all viewer requests for which the response’s HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Percent.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The start of the time interval for which to get metric data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

      You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The end of the time interval for which to get metric data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

      You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

    • period(i32) / set_period(i32):

      The granularity, in seconds, for the metric data points that will be returned.

    • unit(MetricUnit) / set_unit(Option<MetricUnit>):

      The unit for the metric data request.

      Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

    • statistics(Vec<MetricStatistic>) / set_statistics(Option<Vec<MetricStatistic>>):

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

  • On success, responds with GetDistributionMetricDataOutput with field(s):
  • On failure, responds with SdkError<GetDistributionMetricDataError>

Constructs a fluent builder for the GetDistributions operation.

Constructs a fluent builder for the GetDomain operation.

Constructs a fluent builder for the GetDomains operation.

  • The fluent builder is configurable:
    • page_token(impl Into<String>) / set_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • On success, responds with GetDomainsOutput with field(s):
    • domains(Option<Vec<Domain>>):

      An array of key-value pairs containing information about each of the domain entries in the user’s account.

    • next_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter.

  • On failure, responds with SdkError<GetDomainsError>

Constructs a fluent builder for the GetExportSnapshotRecords operation.

Constructs a fluent builder for the GetInstance operation.

Constructs a fluent builder for the GetInstanceAccessDetails operation.

Constructs a fluent builder for the GetInstanceMetricData operation.

  • The fluent builder is configurable:
    • instance_name(impl Into<String>) / set_instance_name(Option<String>):

      The name of the instance for which you want to get metrics data.

    • metric_name(InstanceMetricName) / set_metric_name(Option<InstanceMetricName>):

      The metric for which you want to return information.

      Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance’s BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance’s BurstCapacityPercentage metric reaches 100%.

        Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Seconds.

      • CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

    • period(i32) / set_period(i32):

      The granularity, in seconds, of the returned data points.

      The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The start time of the time period.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The end time of the time period.

    • unit(MetricUnit) / set_unit(Option<MetricUnit>):

      The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units to specify with each available metric, see the metricName parameter.

    • statistics(Vec<MetricStatistic>) / set_statistics(Option<Vec<MetricStatistic>>):

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

  • On success, responds with GetInstanceMetricDataOutput with field(s):
  • On failure, responds with SdkError<GetInstanceMetricDataError>

Constructs a fluent builder for the GetInstancePortStates operation.

Constructs a fluent builder for the GetInstances operation.

  • The fluent builder is configurable:
    • page_token(impl Into<String>) / set_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • On success, responds with GetInstancesOutput with field(s):
    • instances(Option<Vec<Instance>>):

      An array of key-value pairs containing information about your instances.

    • next_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.

  • On failure, responds with SdkError<GetInstancesError>

Constructs a fluent builder for the GetInstanceSnapshot operation.

Constructs a fluent builder for the GetInstanceSnapshots operation.

Constructs a fluent builder for the GetInstanceState operation.

Constructs a fluent builder for the GetKeyPair operation.

Constructs a fluent builder for the GetKeyPairs operation.

Constructs a fluent builder for the GetLoadBalancer operation.

Constructs a fluent builder for the GetLoadBalancerMetricData operation.

  • The fluent builder is configurable:
    • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

      The name of the load balancer.

    • metric_name(LoadBalancerMetricName) / set_metric_name(Option<LoadBalancerMetricName>):

      The metric for which you want to return information.

      Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

      • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • HealthyHostCount - The number of target instances that are considered healthy.

        Statistics: The most useful statistic are Average, Minimum, and Maximum.

        Unit: The published unit is Count.

      • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Seconds.

      • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

        Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

        Unit: The published unit is Count.

      • UnhealthyHostCount - The number of target instances that are considered unhealthy.

        Statistics: The most useful statistic are Average, Minimum, and Maximum.

        Unit: The published unit is Count.

    • period(i32) / set_period(i32):

      The granularity, in seconds, of the returned data points.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The start time of the period.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The end time of the period.

    • unit(MetricUnit) / set_unit(Option<MetricUnit>):

      The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

    • statistics(Vec<MetricStatistic>) / set_statistics(Option<Vec<MetricStatistic>>):

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

  • On success, responds with GetLoadBalancerMetricDataOutput with field(s):
  • On failure, responds with SdkError<GetLoadBalancerMetricDataError>

Constructs a fluent builder for the GetLoadBalancers operation.

Constructs a fluent builder for the GetLoadBalancerTlsCertificates operation.

Constructs a fluent builder for the GetLoadBalancerTlsPolicies operation.

Constructs a fluent builder for the GetOperation operation.

Constructs a fluent builder for the GetOperations operation.

  • The fluent builder is configurable:
    • page_token(impl Into<String>) / set_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetOperations request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • On success, responds with GetOperationsOutput with field(s):
    • operations(Option<Vec<Operation>>):

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

    • next_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetOperations request and specify the next page token using the pageToken parameter.

  • On failure, responds with SdkError<GetOperationsError>

Constructs a fluent builder for the GetOperationsForResource operation.

Constructs a fluent builder for the GetRegions operation.

Constructs a fluent builder for the GetRelationalDatabase operation.

Constructs a fluent builder for the GetRelationalDatabaseBlueprints operation.

Constructs a fluent builder for the GetRelationalDatabaseBundles operation.

Constructs a fluent builder for the GetRelationalDatabaseEvents operation.

Constructs a fluent builder for the GetRelationalDatabaseLogEvents operation.

Constructs a fluent builder for the GetRelationalDatabaseLogStreams operation.

Constructs a fluent builder for the GetRelationalDatabaseMasterUserPassword operation.

Constructs a fluent builder for the GetRelationalDatabaseMetricData operation.

  • The fluent builder is configurable:
    • relational_database_name(impl Into<String>) / set_relational_database_name(Option<String>):

      The name of your database from which to get metric data.

    • metric_name(RelationalDatabaseMetricName) / set_metric_name(Option<RelationalDatabaseMetricName>):

      The metric for which you want to return information.

      Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

      • CPUUtilization - The percentage of CPU utilization currently in use on the database.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • DatabaseConnections - The number of database connections in use.

        Statistics: The most useful statistics are Maximum and Sum.

        Unit: The published unit is Count.

      • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • FreeStorageSpace - The amount of available storage space.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      • NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

    • period(i32) / set_period(i32):

      The granularity, in seconds, of the returned data points.

      All relational database metric data is available in 1-minute (60 seconds) granularity.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The start of the time interval from which to get metric data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The end of the time interval from which to get metric data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

    • unit(MetricUnit) / set_unit(Option<MetricUnit>):

      The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

    • statistics(Vec<MetricStatistic>) / set_statistics(Option<Vec<MetricStatistic>>):

      The statistic for the metric.

      The following statistics are available:

      • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

      • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

      • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

      • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

      • SampleCount - The count, or number, of data points used for the statistical calculation.

  • On success, responds with GetRelationalDatabaseMetricDataOutput with field(s):
  • On failure, responds with SdkError<GetRelationalDatabaseMetricDataError>

Constructs a fluent builder for the GetRelationalDatabaseParameters operation.

Constructs a fluent builder for the GetRelationalDatabases operation.

Constructs a fluent builder for the GetRelationalDatabaseSnapshot operation.

Constructs a fluent builder for the GetRelationalDatabaseSnapshots operation.

Constructs a fluent builder for the GetStaticIp operation.

Constructs a fluent builder for the GetStaticIps operation.

  • The fluent builder is configurable:
    • page_token(impl Into<String>) / set_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      To get a page token, perform an initial GetStaticIps request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

  • On success, responds with GetStaticIpsOutput with field(s):
    • static_ips(Option<Vec<StaticIp>>):

      An array of key-value pairs containing information about your get static IPs request.

    • next_page_token(Option<String>):

      The token to advance to the next page of results from your request.

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetStaticIps request and specify the next page token using the pageToken parameter.

  • On failure, responds with SdkError<GetStaticIpsError>

Constructs a fluent builder for the ImportKeyPair operation.

Constructs a fluent builder for the IsVpcPeered operation.

Constructs a fluent builder for the OpenInstancePublicPorts operation.

Constructs a fluent builder for the PeerVpc operation.

  • The fluent builder takes no input, just send it.
  • On success, responds with PeerVpcOutput with field(s):
    • operation(Option<Operation>):

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • On failure, responds with SdkError<PeerVpcError>

Constructs a fluent builder for the PutAlarm operation.

  • The fluent builder is configurable:
    • alarm_name(impl Into<String>) / set_alarm_name(Option<String>):

      The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

    • metric_name(MetricName) / set_metric_name(Option<MetricName>):

      The name of the metric to associate with the alarm.

      You can configure up to two alarms per metric.

      The following metrics are available for each resource type:

      • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

      • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

      • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

      For more information about these metrics, see Metrics available in Lightsail.

    • monitored_resource_name(impl Into<String>) / set_monitored_resource_name(Option<String>):

      The name of the Lightsail resource that will be monitored.

      Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

    • comparison_operator(ComparisonOperator) / set_comparison_operator(Option<ComparisonOperator>):

      The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

    • threshold(f64) / set_threshold(Option<f64>):

      The value against which the specified statistic is compared.

    • evaluation_periods(i32) / set_evaluation_periods(Option<i32>):

      The number of most recent periods over which data is compared to the specified threshold. If you are setting an “M out of N” alarm, this value (evaluationPeriods) is the N.

      If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

      Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

      You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

    • datapoints_to_alarm(i32) / set_datapoints_to_alarm(Option<i32>):

      The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an “M out of N” alarm, this value (datapointsToAlarm) is the M.

    • treat_missing_data(TreatMissingData) / set_treat_missing_data(Option<TreatMissingData>):

      Sets how this alarm will handle missing data points.

      An alarm can treat missing data in the following ways:

      • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

      • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

      • ignore - Ignore the missing data. Maintains the current alarm state.

      • missing - Missing data is treated as missing.

      If treatMissingData is not specified, the default behavior of missing is used.

    • contact_protocols(Vec<ContactProtocol>) / set_contact_protocols(Option<Vec<ContactProtocol>>):

      The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

      A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

      A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the Amazon Web Services Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

      Use the CreateContactMethod action to configure a contact protocol in an Amazon Web Services Region.

    • notification_triggers(Vec<AlarmState>) / set_notification_triggers(Option<Vec<AlarmState>>):

      The alarm states that trigger a notification.

      An alarm has the following possible states:

      • ALARM - The metric is outside of the defined threshold.

      • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

      • OK - The metric is within the defined threshold.

      When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

      • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

      • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

      The notification trigger defaults to ALARM if you don’t specify this parameter.

    • notification_enabled(bool) / set_notification_enabled(Option<bool>):

      Indicates whether the alarm is enabled.

      Notifications are enabled by default if you don’t specify this parameter.

  • On success, responds with PutAlarmOutput with field(s):
    • operations(Option<Vec<Operation>>):

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • On failure, responds with SdkError<PutAlarmError>

Constructs a fluent builder for the PutInstancePublicPorts operation.

Constructs a fluent builder for the RebootInstance operation.

Constructs a fluent builder for the RebootRelationalDatabase operation.

Constructs a fluent builder for the RegisterContainerImage operation.

  • The fluent builder is configurable:
    • service_name(impl Into<String>) / set_service_name(Option<String>):

      The name of the container service for which to register a container image.

    • label(impl Into<String>) / set_label(Option<String>):

      The label for the container image when it’s registered to the container service.

      Use a descriptive label that you can use to track the different versions of your registered container images.

      Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the portion of the following image name example:

      • :container-service-1. .1

      If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.

      The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.

    • digest(impl Into<String>) / set_digest(Option<String>):

      The digest of the container image to be registered.

  • On success, responds with RegisterContainerImageOutput with field(s):
  • On failure, responds with SdkError<RegisterContainerImageError>

Constructs a fluent builder for the ReleaseStaticIp operation.

Constructs a fluent builder for the ResetDistributionCache operation.

Constructs a fluent builder for the SendContactMethodVerification operation.

Constructs a fluent builder for the SetIpAddressType operation.

Constructs a fluent builder for the SetResourceAccessForBucket operation.

Constructs a fluent builder for the StartInstance operation.

Constructs a fluent builder for the StartRelationalDatabase operation.

Constructs a fluent builder for the StopInstance operation.

Constructs a fluent builder for the StopRelationalDatabase operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the TestAlarm operation.

Constructs a fluent builder for the UnpeerVpc operation.

  • The fluent builder takes no input, just send it.
  • On success, responds with UnpeerVpcOutput with field(s):
    • operation(Option<Operation>):

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • On failure, responds with SdkError<UnpeerVpcError>

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateBucket operation.

Constructs a fluent builder for the UpdateBucketBundle operation.

Constructs a fluent builder for the UpdateContainerService operation.

  • The fluent builder is configurable:
    • service_name(impl Into<String>) / set_service_name(Option<String>):

      The name of the container service to update.

    • power(ContainerServicePowerName) / set_power(Option<ContainerServicePowerName>):

      The power for the container service.

      The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

      Use the GetContainerServicePowers action to view the specifications of each power option.

    • scale(i32) / set_scale(Option<i32>):

      The scale for the container service.

      The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

    • is_disabled(bool) / set_is_disabled(Option<bool>):

      A Boolean value to indicate whether the container service is disabled.

    • public_domain_names(HashMap<String, Vec<String>>) / set_public_domain_names(Option<HashMap<String, Vec<String>>>):

      The public domain names to use with the container service, such as example.com and www.example.com.

      You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

      If you don’t specify public domain names, then you can use the default domain of the container service.

      You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

      You can specify public domain names using a string to array map as shown in the example later on this page.

  • On success, responds with UpdateContainerServiceOutput with field(s):
  • On failure, responds with SdkError<UpdateContainerServiceError>

Constructs a fluent builder for the UpdateDistribution operation.

Constructs a fluent builder for the UpdateDistributionBundle operation.

source

pub fn update_domain_entry(&self) -> UpdateDomainEntry

Constructs a fluent builder for the UpdateDomainEntry operation.

Constructs a fluent builder for the UpdateLoadBalancerAttribute operation.

  • The fluent builder is configurable:
    • load_balancer_name(impl Into<String>) / set_load_balancer_name(Option<String>):

      The name of the load balancer that you want to modify (e.g., my-load-balancer.

    • attribute_name(LoadBalancerAttributeName) / set_attribute_name(Option<LoadBalancerAttributeName>):

      The name of the attribute you want to update.

    • attribute_value(impl Into<String>) / set_attribute_value(Option<String>):

      The value that you want to specify for the attribute name.

      The following values are supported depending on what you specify for the attributeName request parameter:

      • If you specify HealthCheckPath for the attributeName request parameter, then the attributeValue request parameter must be the path to ping on the target (for example, /weather/us/wa/seattle).

      • If you specify SessionStickinessEnabled for the attributeName request parameter, then the attributeValue request parameter must be true or false.

      • If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName request parameter, then the attributeValue request parameter must be an interger that represents the cookie duration in seconds.

      • If you specify HttpsRedirectionEnabled for the attributeName request parameter, then the attributeValue request parameter must be true or false.

      • If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be TLS version 1.0, 1.1, and 1.2 or TLS version 1.2.

  • On success, responds with UpdateLoadBalancerAttributeOutput with field(s):
    • operations(Option<Vec<Operation>>):

      An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • On failure, responds with SdkError<UpdateLoadBalancerAttributeError>

Constructs a fluent builder for the UpdateRelationalDatabase operation.

Constructs a fluent builder for the UpdateRelationalDatabaseParameters operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more