Struct Client 

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_lightsail::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_lightsail::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AllocateStaticIp operation has a Client::allocate_static_ip, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.allocate_static_ip()
    .static_ip_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn allocate_static_ip(&self) -> AllocateStaticIpFluentBuilder

Constructs a fluent builder for the AllocateStaticIp operation.

• The fluent builder is configurable:
  • static_ip_name(impl Into<String>) / set_static_ip_name(Option<String>):
    required: true
    

    The name of the static IP address.

    
    
• On success, responds with AllocateStaticIpOutput 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<AllocateStaticIpError>

impl Client

pub fn attach_certificate_to_distribution( &self, ) -> AttachCertificateToDistributionFluentBuilder

Constructs a fluent builder for the AttachCertificateToDistribution operation.

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

    The name of the distribution that the certificate will be attached to.

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

    
    
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: true
    

    The name of the certificate to attach to a distribution.

    Only certificates with a status of ISSUED can be attached to a distribution.

    Use the GetCertificates action to get a list of certificate names that you can specify.

    This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.

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

    An object that describes 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<AttachCertificateToDistributionError>

impl Client

pub fn attach_disk(&self) -> AttachDiskFluentBuilder

Constructs a fluent builder for the AttachDisk operation.

• The fluent builder is configurable:
  • disk_name(impl Into<String>) / set_disk_name(Option<String>):
    required: true
    

    The unique Lightsail disk name (my-disk).

    
    
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: true
    

    The name of the Lightsail instance where you want to utilize the storage disk.

    
    
  • disk_path(impl Into<String>) / set_disk_path(Option<String>):
    required: true
    

    The disk path to expose to the instance (/dev/xvdf).

    
    
  • auto_mounting(bool) / set_auto_mounting(Option<bool>):
    required: false
    

    A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is False.

    This value only applies to Lightsail for Research resources.

    
    
• On success, responds with AttachDiskOutput 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<AttachDiskError>

impl Client

pub fn attach_instances_to_load_balancer( &self, ) -> AttachInstancesToLoadBalancerFluentBuilder

Constructs a fluent builder for the AttachInstancesToLoadBalancer operation.

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

    The name of the load balancer.

    
    
  • instance_names(impl Into<String>) / set_instance_names(Option<Vec::<String>>):
    required: true
    

    An array of strings representing the instance name(s) you want to attach to your load balancer.

    An instance must be running before you can attach it to your load balancer.

    There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).

    
    
• On success, responds with AttachInstancesToLoadBalancerOutput 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<AttachInstancesToLoadBalancerError>

impl Client

pub fn attach_load_balancer_tls_certificate( &self, ) -> AttachLoadBalancerTlsCertificateFluentBuilder

Constructs a fluent builder for the AttachLoadBalancerTlsCertificate operation.

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

    The name of the load balancer to which you want to associate the SSL/TLS certificate.

    
    
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: true
    

    The name of your SSL/TLS certificate.

    
    
• On success, responds with AttachLoadBalancerTlsCertificateOutput 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.

    These SSL/TLS certificates are only usable by Lightsail load balancers. You can’t get the certificate and use it for another purpose.

• On failure, responds with SdkError<AttachLoadBalancerTlsCertificateError>

impl Client

pub fn attach_static_ip(&self) -> AttachStaticIpFluentBuilder

Constructs a fluent builder for the AttachStaticIp operation.

• The fluent builder is configurable:
  • static_ip_name(impl Into<String>) / set_static_ip_name(Option<String>):
    required: true
    

    The name of the static IP.

    
    
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: true
    

    The instance name to which you want to attach the static IP address.

    
    
• On success, responds with AttachStaticIpOutput 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<AttachStaticIpError>

impl Client

pub fn close_instance_public_ports( &self, ) -> CloseInstancePublicPortsFluentBuilder

Constructs a fluent builder for the CloseInstancePublicPorts operation.

• The fluent builder is configurable:
  • port_info(PortInfo) / set_port_info(Option<PortInfo>):
    required: true
    

    An object to describe the ports to close for the specified instance.

    
    
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: true
    

    The name of the instance for which to close ports.

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

    An object that describes 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<CloseInstancePublicPortsError>

impl Client

pub fn copy_snapshot(&self) -> CopySnapshotFluentBuilder

Constructs a fluent builder for the CopySnapshot operation.

• The fluent builder is configurable:
  • source_snapshot_name(impl Into<String>) / set_source_snapshot_name(Option<String>):
    required: false
    

    The name of the source manual snapshot to copy.

    Constraint:

    • Define this parameter only when copying a manual snapshot as another manual snapshot.

    
    
  • source_resource_name(impl Into<String>) / set_source_resource_name(Option<String>):
    required: false
    

    The name of the source instance or disk from which the source automatic snapshot was created.

    Constraint:

    • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
  • restore_date(impl Into<String>) / set_restore_date(Option<String>):
    required: false
    

    The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

    Constraints:

    • Must be specified in YYYY-MM-DD format.

    • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

    • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
  • use_latest_restorable_auto_snapshot(bool) / set_use_latest_restorable_auto_snapshot(Option<bool>):
    required: false
    

    A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.

    Constraints:

    • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

    • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
  • target_snapshot_name(impl Into<String>) / set_target_snapshot_name(Option<String>):
    required: true
    

    The name of the new manual snapshot to be created as a copy.

    
    
  • source_region(RegionName) / set_source_region(Option<RegionName>):
    required: true
    

    The Amazon Web Services Region where the source manual or automatic snapshot is located.

    
    
• On success, responds with CopySnapshotOutput 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<CopySnapshotError>

impl Client

pub fn create_bucket(&self) -> CreateBucketFluentBuilder

Constructs a fluent builder for the CreateBucket operation.

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

    The name for the bucket.

    For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer Guide.

    
    
  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):
    required: true
    

    The ID of the bundle to use for the bucket.

    A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

    Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

    Use the UpdateBucketBundle action to change the bundle after the bucket is created.

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

    The tag keys and optional values to add to the bucket during creation.

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

    
    
  • enable_object_versioning(bool) / set_enable_object_versioning(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to enable versioning of objects in the bucket.

    For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

    
    
• On success, responds with CreateBucketOutput with field(s):
  • bucket(Option<Bucket>):

    An object that describes the bucket that is created.

  • 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<CreateBucketError>

impl Client

pub fn create_bucket_access_key(&self) -> CreateBucketAccessKeyFluentBuilder

Constructs a fluent builder for the CreateBucketAccessKey operation.

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

    The name of the bucket that the new access key will belong to, and grant access to.

    
    
• On success, responds with CreateBucketAccessKeyOutput with field(s):
  • access_key(Option<AccessKey>):

    An object that describes the access key that is created.

  • 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<CreateBucketAccessKeyError>

impl Client

pub fn create_certificate(&self) -> CreateCertificateFluentBuilder

Constructs a fluent builder for the CreateCertificate operation.

• The fluent builder is configurable:
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: true
    

    The name for the certificate.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The domain name (example.com) for the certificate.

    
    
  • subject_alternative_names(impl Into<String>) / set_subject_alternative_names(Option<Vec::<String>>):
    required: false
    

    An array of strings that specify the alternate domains (example2.com) and subdomains (blog.example.com) for the certificate.

    You can specify a maximum of nine alternate domains (in addition to the primary domain name).

    Wildcard domain entries (*.example.com) are not supported.

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

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

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

    
    
• On success, responds with CreateCertificateOutput with field(s):
  • certificate(Option<CertificateSummary>):

    An object that describes the certificate created.

  • 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<CreateCertificateError>

impl Client

pub fn create_cloud_formation_stack( &self, ) -> CreateCloudFormationStackFluentBuilder

Constructs a fluent builder for the CreateCloudFormationStack operation.

• The fluent builder is configurable:
  • instances(InstanceEntry) / set_instances(Option<Vec::<InstanceEntry>>):
    required: true
    

    An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.

    
    
• On success, responds with CreateCloudFormationStackOutput 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<CreateCloudFormationStackError>

impl Client

pub fn create_contact_method(&self) -> CreateContactMethodFluentBuilder

Constructs a fluent builder for the CreateContactMethod operation.

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

    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>):
    required: true
    

    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>

impl Client

pub fn create_container_service(&self) -> CreateContainerServiceFluentBuilder

Constructs a fluent builder for the CreateContainerService operation.

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

    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) Amazon Web Services 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>):
    required: true
    

    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>):
    required: true
    

    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(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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(impl Into<String>, Vec::<String>) / set_public_domain_names(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    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>):
    required: false
    

    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.

    
    
  • private_registry_access(PrivateRegistryAccessRequest) / set_private_registry_access(Option<PrivateRegistryAccessRequest>):
    required: false
    

    An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

    For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

    
    
• On success, responds with CreateContainerServiceOutput with field(s):
  • container_service(Option<ContainerService>):

    An object that describes a container service.

• On failure, responds with SdkError<CreateContainerServiceError>

impl Client

pub fn create_container_service_deployment( &self, ) -> CreateContainerServiceDeploymentFluentBuilder

Constructs a fluent builder for the CreateContainerServiceDeployment operation.

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

    The name of the container service for which to create the deployment.

    
    
  • containers(impl Into<String>, Container) / set_containers(Option<HashMap::<String, Container>>):
    required: false
    

    An object that describes the settings of the containers that will be launched on the container service.

    
    
  • public_endpoint(EndpointRequest) / set_public_endpoint(Option<EndpointRequest>):
    required: false
    

    An object that describes the settings of the public endpoint for the container service.

    
    
• On success, responds with CreateContainerServiceDeploymentOutput with field(s):
  • container_service(Option<ContainerService>):

    An object that describes a container service.

• On failure, responds with SdkError<CreateContainerServiceDeploymentError>

impl Client

pub fn create_container_service_registry_login( &self, ) -> CreateContainerServiceRegistryLoginFluentBuilder

Constructs a fluent builder for the CreateContainerServiceRegistryLogin operation.

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

    An object that describes the log in information for the container service registry of your Lightsail account.

• On failure, responds with SdkError<CreateContainerServiceRegistryLoginError>

impl Client

pub fn create_disk(&self) -> CreateDiskFluentBuilder

Constructs a fluent builder for the CreateDisk operation.

• The fluent builder is configurable:
  • disk_name(impl Into<String>) / set_disk_name(Option<String>):
    required: true
    

    The unique Lightsail disk name (my-disk).

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

    The Availability Zone where you want to create the disk (us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

    Use the get regions operation to list the Availability Zones where Lightsail is currently available.

    
    
  • size_in_gb(i32) / set_size_in_gb(Option<i32>):
    required: true
    

    The size of the disk in GB (32).

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

    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.

    
    
  • add_ons(AddOnRequest) / set_add_ons(Option<Vec::<AddOnRequest>>):
    required: false
    

    An array of objects that represent the add-ons to enable for the new disk.

    
    
• On success, responds with CreateDiskOutput 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<CreateDiskError>

impl Client

pub fn create_disk_from_snapshot(&self) -> CreateDiskFromSnapshotFluentBuilder

Constructs a fluent builder for the CreateDiskFromSnapshot operation.

• The fluent builder is configurable:
  • disk_name(impl Into<String>) / set_disk_name(Option<String>):
    required: true
    

    The unique Lightsail disk name (my-disk).

    
    
  • disk_snapshot_name(impl Into<String>) / set_disk_snapshot_name(Option<String>):
    required: false
    

    The name of the disk snapshot (my-snapshot) from which to create the new storage disk.

    Constraint:

    • This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

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

    The Availability Zone where you want to create the disk (us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

    Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

    
    
  • size_in_gb(i32) / set_size_in_gb(Option<i32>):
    required: true
    

    The size of the disk in GB (32).

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

    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.

    
    
  • add_ons(AddOnRequest) / set_add_ons(Option<Vec::<AddOnRequest>>):
    required: false
    

    An array of objects that represent the add-ons to enable for the new disk.

    
    
  • source_disk_name(impl Into<String>) / set_source_disk_name(Option<String>):
    required: false
    

    The name of the source disk from which the source automatic snapshot was created.

    Constraints:

    • This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.

    • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
  • restore_date(impl Into<String>) / set_restore_date(Option<String>):
    required: false
    

    The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

    Constraints:

    • Must be specified in YYYY-MM-DD format.

    • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

    • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
  • use_latest_restorable_auto_snapshot(bool) / set_use_latest_restorable_auto_snapshot(Option<bool>):
    required: false
    

    A Boolean value to indicate whether to use the latest available automatic snapshot.

    Constraints:

    • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

    • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
• On success, responds with CreateDiskFromSnapshotOutput 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<CreateDiskFromSnapshotError>

impl Client

pub fn create_disk_snapshot(&self) -> CreateDiskSnapshotFluentBuilder

Constructs a fluent builder for the CreateDiskSnapshot operation.

• The fluent builder is configurable:
  • disk_name(impl Into<String>) / set_disk_name(Option<String>):
    required: false
    

    The unique name of the source disk (Disk-Virginia-1).

    This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

    
    
  • disk_snapshot_name(impl Into<String>) / set_disk_snapshot_name(Option<String>):
    required: true
    

    The name of the destination disk snapshot (my-disk-snapshot) based on the source disk.

    
    
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: false
    

    The unique name of the source instance (Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance’s system volume is created.

    This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

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

    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 CreateDiskSnapshotOutput 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<CreateDiskSnapshotError>

impl Client

pub fn create_distribution(&self) -> CreateDistributionFluentBuilder

Constructs a fluent builder for the CreateDistribution operation.

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

    The name for the distribution.

    
    
  • origin(InputOrigin) / set_origin(Option<InputOrigin>):
    required: true
    

    An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

    The distribution pulls, caches, and serves content from the origin.

    
    
  • default_cache_behavior(CacheBehavior) / set_default_cache_behavior(Option<CacheBehavior>):
    required: true
    

    An object that describes the default cache behavior for the distribution.

    
    
  • cache_behavior_settings(CacheSettings) / set_cache_behavior_settings(Option<CacheSettings>):
    required: false
    

    An object that describes the cache behavior settings for the distribution.

    
    
  • cache_behaviors(CacheBehaviorPerPath) / set_cache_behaviors(Option<Vec::<CacheBehaviorPerPath>>):
    required: false
    

    An array of objects that describe the per-path cache behavior for the distribution.

    
    
  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):
    required: true
    

    The bundle ID to use for the distribution.

    A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.

    Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    The IP address type for the distribution.

    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

    The default value is dualstack.

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

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

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

    
    
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: false
    

    The name of the SSL/TLS certificate that you want to attach to the distribution.

    Use the GetCertificates action to get a list of certificate names that you can specify.

    
    
  • viewer_minimum_tls_protocol_version(ViewerMinimumTlsProtocolVersionEnum) / set_viewer_minimum_tls_protocol_version(Option<ViewerMinimumTlsProtocolVersionEnum>):
    required: false
    

    The minimum TLS protocol version for the SSL/TLS certificate.

    
    
• On success, responds with CreateDistributionOutput with field(s):
  • distribution(Option<LightsailDistribution>):

    An object that describes the distribution created.

  • 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<CreateDistributionError>

impl Client

pub fn create_domain(&self) -> CreateDomainFluentBuilder

Constructs a fluent builder for the CreateDomain operation.

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

    The domain name to manage (example.com).

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

    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>

impl Client

pub fn create_domain_entry(&self) -> CreateDomainEntryFluentBuilder

Constructs a fluent builder for the CreateDomainEntry operation.

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

    The domain name (example.com) for which you want to create the domain entry.

    
    
  • domain_entry(DomainEntry) / set_domain_entry(Option<DomainEntry>):
    required: true
    

    An array of key-value pairs containing information about the domain entry request.

    
    
• On success, responds with CreateDomainEntryOutput 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<CreateDomainEntryError>

impl Client

pub fn create_gui_session_access_details( &self, ) -> CreateGUISessionAccessDetailsFluentBuilder

Constructs a fluent builder for the CreateGUISessionAccessDetails operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The resource name.

    
    
• On success, responds with CreateGuiSessionAccessDetailsOutput with field(s):
  • resource_name(Option<String>):

    The resource name.

  • status(Option<Status>):

    The status of the operation.

  • percentage_complete(Option<i32>):

    The percentage of completion for the operation.

  • failure_reason(Option<String>):

    The reason the operation failed.

  • sessions(Option<Vec::<Session>>):

    Returns information about the specified Amazon DCV GUI session.

• On failure, responds with SdkError<CreateGUISessionAccessDetailsError>

impl Client

pub fn create_instance_snapshot(&self) -> CreateInstanceSnapshotFluentBuilder

Constructs a fluent builder for the CreateInstanceSnapshot operation.

• The fluent builder is configurable:
  • instance_snapshot_name(impl Into<String>) / set_instance_snapshot_name(Option<String>):
    required: true
    

    The name for your new snapshot.

    
    
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: true
    

    The Lightsail instance on which to base your snapshot.

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

    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 CreateInstanceSnapshotOutput 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<CreateInstanceSnapshotError>

impl Client

pub fn create_instances(&self) -> CreateInstancesFluentBuilder

Constructs a fluent builder for the CreateInstances operation.

• The fluent builder is configurable:
  • instance_names(impl Into<String>) / set_instance_names(Option<Vec::<String>>):
    required: true
    

    The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: [“MyFirstInstance”,“MySecondInstance”]

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

    The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

    
    
  • custom_image_name(impl Into<String>) / set_custom_image_name(Option<String>):
    required: false
    

    (Discontinued) The name for your custom image.

    In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.

    
    
  • blueprint_id(impl Into<String>) / set_blueprint_id(Option<String>):
    required: true
    

    The ID for a virtual private server image (app_wordpress_x_x or app_lamp_x_x). Use the get blueprints operation to return a list of available images (or blueprints).

    Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

    
    
  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):
    required: true
    

    The bundle of specification information for your virtual private server (or instance), including the pricing plan (medium_x_x).

    
    
  • user_data(impl Into<String>) / set_user_data(Option<String>):
    required: false
    

    A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

    Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

    
    
  • key_pair_name(impl Into<String>) / set_key_pair_name(Option<String>):
    required: false
    

    The name of your key pair.

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

    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.

    
    
  • add_ons(AddOnRequest) / set_add_ons(Option<Vec::<AddOnRequest>>):
    required: false
    

    An array of objects representing the add-ons to enable for the new instance.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    The IP address type for the instance.

    The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

    The default value is dualstack.

    
    
• On success, responds with CreateInstancesOutput 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<CreateInstancesError>

impl Client

pub fn create_instances_from_snapshot( &self, ) -> CreateInstancesFromSnapshotFluentBuilder

Constructs a fluent builder for the CreateInstancesFromSnapshot operation.

• The fluent builder is configurable:
  • instance_names(impl Into<String>) / set_instance_names(Option<Vec::<String>>):
    required: true
    

    The names for your new instances.

    
    
  • attached_disk_mapping(impl Into<String>, Vec::<DiskMap>) / set_attached_disk_mapping(Option<HashMap::<String, Vec::<DiskMap>>>):
    required: false
    

    An object containing information about one or more disk mappings.

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

    The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

    
    
  • instance_snapshot_name(impl Into<String>) / set_instance_snapshot_name(Option<String>):
    required: false
    

    The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

    Constraint:

    • This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

    
    
  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):
    required: true
    

    The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_x_x).

    
    
  • user_data(impl Into<String>) / set_user_data(Option<String>):
    required: false
    

    You can create a launch script that configures a server with additional user data. For example, apt-get -y update.

    Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

    
    
  • key_pair_name(impl Into<String>) / set_key_pair_name(Option<String>):
    required: false
    

    The name for your key pair.

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

    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.

    
    
  • add_ons(AddOnRequest) / set_add_ons(Option<Vec::<AddOnRequest>>):
    required: false
    

    An array of objects representing the add-ons to enable for the new instance.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    The IP address type for the instance.

    The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

    The default value is dualstack.

    
    
  • source_instance_name(impl Into<String>) / set_source_instance_name(Option<String>):
    required: false
    

    The name of the source instance from which the source automatic snapshot was created.

    Constraints:

    • This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.

    • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
  • restore_date(impl Into<String>) / set_restore_date(Option<String>):
    required: false
    

    The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

    Constraints:

    • Must be specified in YYYY-MM-DD format.

    • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

    • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
  • use_latest_restorable_auto_snapshot(bool) / set_use_latest_restorable_auto_snapshot(Option<bool>):
    required: false
    

    A Boolean value to indicate whether to use the latest available automatic snapshot.

    Constraints:

    • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

    • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

    
    
• On success, responds with CreateInstancesFromSnapshotOutput 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<CreateInstancesFromSnapshotError>

impl Client

pub fn create_key_pair(&self) -> CreateKeyPairFluentBuilder

Constructs a fluent builder for the CreateKeyPair operation.

• The fluent builder is configurable:
  • key_pair_name(impl Into<String>) / set_key_pair_name(Option<String>):
    required: true
    

    The name for your new key pair.

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

    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 CreateKeyPairOutput with field(s):
  • key_pair(Option<KeyPair>):

    An array of key-value pairs containing information about the new key pair you just created.

  • public_key_base64(Option<String>):

    A base64-encoded public key of the ssh-rsa type.

  • private_key_base64(Option<String>):

    A base64-encoded RSA private key.

  • 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<CreateKeyPairError>

impl Client

pub fn create_load_balancer(&self) -> CreateLoadBalancerFluentBuilder

Constructs a fluent builder for the CreateLoadBalancer operation.

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

    The name of your load balancer.

    
    
  • instance_port(i32) / set_instance_port(Option<i32>):
    required: true
    

    The instance port where you’re creating your load balancer.

    
    
  • health_check_path(impl Into<String>) / set_health_check_path(Option<String>):
    required: false
    

    The path you provided to perform the load balancer health check. If you didn’t specify a health check path, Lightsail uses the root path of your website (“/”).

    You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

    
    
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: false
    

    The name of the SSL/TLS certificate.

    If you specify certificateName, then certificateDomainName is required (and vice-versa).

    
    
  • certificate_domain_name(impl Into<String>) / set_certificate_domain_name(Option<String>):
    required: false
    

    The domain name with which your certificate is associated (example.com).

    If you specify certificateDomainName, then certificateName is required (and vice-versa).

    
    
  • certificate_alternative_names(impl Into<String>) / set_certificate_alternative_names(Option<Vec::<String>>):
    required: false
    

    The optional alternative domains and subdomains to use with your SSL/TLS certificate (www.example.com, example.com, m.example.com, blog.example.com).

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

    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.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: false
    

    The IP address type for the load balancer.

    The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

    The default value is dualstack.

    
    
  • tls_policy_name(impl Into<String>) / set_tls_policy_name(Option<String>):
    required: false
    

    The name of the TLS policy to apply to the load balancer.

    Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

    For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

    
    
• On success, responds with CreateLoadBalancerOutput 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<CreateLoadBalancerError>

impl Client

pub fn create_load_balancer_tls_certificate( &self, ) -> CreateLoadBalancerTlsCertificateFluentBuilder

Constructs a fluent builder for the CreateLoadBalancerTlsCertificate operation.

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

    The load balancer name where you want to create the SSL/TLS certificate.

    
    
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: true
    

    The SSL/TLS certificate name.

    You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.

    
    
  • certificate_domain_name(impl Into<String>) / set_certificate_domain_name(Option<String>):
    required: true
    

    The domain name (example.com) for your SSL/TLS certificate.

    
    
  • certificate_alternative_names(impl Into<String>) / set_certificate_alternative_names(Option<Vec::<String>>):
    required: false
    

    An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (*.example.com).

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

    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 CreateLoadBalancerTlsCertificateOutput 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<CreateLoadBalancerTlsCertificateError>

impl Client

pub fn create_relational_database( &self, ) -> CreateRelationalDatabaseFluentBuilder

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>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    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 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>):
    required: false
    

    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>):
    required: false
    

    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(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>

impl Client

pub fn create_relational_database_from_snapshot( &self, ) -> CreateRelationalDatabaseFromSnapshotFluentBuilder

Constructs a fluent builder for the CreateRelationalDatabaseFromSnapshot operation.

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

    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>):
    required: false
    

    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.

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

    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.

    
    
  • relational_database_snapshot_name(impl Into<String>) / set_relational_database_snapshot_name(Option<String>):
    required: false
    

    The name of the database snapshot from which to create your new database.

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

    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.

    When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

    
    
  • source_relational_database_name(impl Into<String>) / set_source_relational_database_name(Option<String>):
    required: false
    

    The name of the source database.

    
    
  • restore_time(DateTime) / set_restore_time(Option<DateTime>):
    required: false
    

    The date and time to restore your database from.

    Constraints:

    • Must be before the latest restorable time for the database.

    • Cannot be specified if the use latest restorable time parameter is true.

    • Specified in Coordinated Universal Time (UTC).

    • Specified in the Unix time format.

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

    
    
  • use_latest_restorable_time(bool) / set_use_latest_restorable_time(Option<bool>):
    required: false
    

    Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time.

    Default: false

    Constraints: Cannot be specified if the restore time parameter is provided.

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

    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 CreateRelationalDatabaseFromSnapshotOutput 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<CreateRelationalDatabaseFromSnapshotError>

impl Client

pub fn create_relational_database_snapshot( &self, ) -> CreateRelationalDatabaseSnapshotFluentBuilder

Constructs a fluent builder for the CreateRelationalDatabaseSnapshot operation.

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

    The name of the database on which to base your new snapshot.

    
    
  • relational_database_snapshot_name(impl Into<String>) / set_relational_database_snapshot_name(Option<String>):
    required: true
    

    The name for your new database snapshot.

    Constraints:

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

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

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

    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 CreateRelationalDatabaseSnapshotOutput 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<CreateRelationalDatabaseSnapshotError>

impl Client

pub fn delete_alarm(&self) -> DeleteAlarmFluentBuilder

Constructs a fluent builder for the DeleteAlarm operation.

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

    The name of the alarm to delete.

    
    
• On success, responds with DeleteAlarmOutput 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<DeleteAlarmError>

impl Client

pub fn delete_auto_snapshot(&self) -> DeleteAutoSnapshotFluentBuilder

Constructs a fluent builder for the DeleteAutoSnapshot operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the source instance or disk from which to delete the automatic snapshot.

    
    
  • date(impl Into<String>) / set_date(Option<String>):
    required: true
    

    The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get auto snapshots operation to get the available automatic snapshots for a resource.

    
    
• On success, responds with DeleteAutoSnapshotOutput 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<DeleteAutoSnapshotError>

impl Client

pub fn delete_bucket(&self) -> DeleteBucketFluentBuilder

Constructs a fluent builder for the DeleteBucket operation.

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

    The name of the bucket to delete.

    Use the GetBuckets action to get a list of bucket names that you can specify.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to force delete the bucket.

    You must force delete the bucket if it has one of the following conditions:

    • The bucket is the origin of a distribution.

    • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.

    • The bucket has objects.

    • The bucket has access keys.

    Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

    
    
• On success, responds with DeleteBucketOutput 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<DeleteBucketError>

impl Client

pub fn delete_bucket_access_key(&self) -> DeleteBucketAccessKeyFluentBuilder

Constructs a fluent builder for the DeleteBucketAccessKey operation.

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

    The name of the bucket that the access key belongs to.

    
    
  • access_key_id(impl Into<String>) / set_access_key_id(Option<String>):
    required: true
    

    The ID of the access key to delete.

    Use the GetBucketAccessKeys action to get a list of access key IDs that you can specify.

    
    
• On success, responds with DeleteBucketAccessKeyOutput 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<DeleteBucketAccessKeyError>

impl Client

pub fn delete_certificate(&self) -> DeleteCertificateFluentBuilder

Constructs a fluent builder for the DeleteCertificate operation.

• The fluent builder is configurable:
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: true
    

    The name of the certificate to delete.

    Use the GetCertificates action to get a list of certificate names that you can specify.

    
    
• On success, responds with DeleteCertificateOutput 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<DeleteCertificateError>

impl Client

pub fn delete_contact_method(&self) -> DeleteContactMethodFluentBuilder

Constructs a fluent builder for the DeleteContactMethod operation.

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

    The protocol that will be deleted, such as Email or SMS (text messaging).

    To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.

    
    
• On success, responds with DeleteContactMethodOutput 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<DeleteContactMethodError>

impl Client

pub fn delete_container_image(&self) -> DeleteContainerImageFluentBuilder

Constructs a fluent builder for the DeleteContainerImage operation.

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

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

    
    
  • image(impl Into<String>) / set_image(Option<String>):
    required: true
    

    The name of the container image to delete from the container service.

    Use the GetContainerImages action to get the name of the container images that are registered to a container service.

    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, :container-service-1.mystaticwebsite.1. Container images sourced from a public registry like Docker Hub don’t start with a colon. For example, nginx:latest or nginx.

    
    
• On success, responds with DeleteContainerImageOutput
• On failure, responds with SdkError<DeleteContainerImageError>

impl Client

pub fn delete_container_service(&self) -> DeleteContainerServiceFluentBuilder

Constructs a fluent builder for the DeleteContainerService operation.

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

    The name of the container service to delete.

    
    
• On success, responds with DeleteContainerServiceOutput
• On failure, responds with SdkError<DeleteContainerServiceError>

impl Client

pub fn delete_disk(&self) -> DeleteDiskFluentBuilder

Constructs a fluent builder for the DeleteDisk operation.

• The fluent builder is configurable:
  • disk_name(impl Into<String>) / set_disk_name(Option<String>):
    required: true
    

    The unique name of the disk you want to delete (my-disk).

    
    
  • force_delete_add_ons(bool) / set_force_delete_add_ons(Option<bool>):
    required: false
    

    A Boolean value to indicate whether to delete all add-ons for the disk.

    
    
• On success, responds with DeleteDiskOutput 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<DeleteDiskError>

impl Client

pub fn delete_disk_snapshot(&self) -> DeleteDiskSnapshotFluentBuilder

Constructs a fluent builder for the DeleteDiskSnapshot operation.

• The fluent builder is configurable:
  • disk_snapshot_name(impl Into<String>) / set_disk_snapshot_name(Option<String>):
    required: true
    

    The name of the disk snapshot you want to delete (my-disk-snapshot).

    
    
• On success, responds with DeleteDiskSnapshotOutput 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<DeleteDiskSnapshotError>

impl Client

pub fn delete_distribution(&self) -> DeleteDistributionFluentBuilder

Constructs a fluent builder for the DeleteDistribution operation.

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

    The name of the distribution to delete.

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

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

    An object that describes 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<DeleteDistributionError>

impl Client

pub fn delete_domain(&self) -> DeleteDomainFluentBuilder

Constructs a fluent builder for the DeleteDomain operation.

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

    The specific domain name to delete.

    
    
• On success, responds with DeleteDomainOutput 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<DeleteDomainError>

impl Client

pub fn delete_domain_entry(&self) -> DeleteDomainEntryFluentBuilder

Constructs a fluent builder for the DeleteDomainEntry operation.

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

    The name of the domain entry to delete.

    
    
  • domain_entry(DomainEntry) / set_domain_entry(Option<DomainEntry>):
    required: true
    

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

    
    
• On success, responds with DeleteDomainEntryOutput 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<DeleteDomainEntryError>

impl Client

pub fn delete_instance(&self) -> DeleteInstanceFluentBuilder

Constructs a fluent builder for the DeleteInstance operation.

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

    The name of the instance to delete.

    
    
  • force_delete_add_ons(bool) / set_force_delete_add_ons(Option<bool>):
    required: false
    

    A Boolean value to indicate whether to delete all add-ons for the instance.

    
    
• On success, responds with DeleteInstanceOutput 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<DeleteInstanceError>

impl Client

pub fn delete_instance_snapshot(&self) -> DeleteInstanceSnapshotFluentBuilder

Constructs a fluent builder for the DeleteInstanceSnapshot operation.

• The fluent builder is configurable:
  • instance_snapshot_name(impl Into<String>) / set_instance_snapshot_name(Option<String>):
    required: true
    

    The name of the snapshot to delete.

    
    
• On success, responds with DeleteInstanceSnapshotOutput 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<DeleteInstanceSnapshotError>

impl Client

pub fn delete_key_pair(&self) -> DeleteKeyPairFluentBuilder

Constructs a fluent builder for the DeleteKeyPair operation.

• The fluent builder is configurable:
  • key_pair_name(impl Into<String>) / set_key_pair_name(Option<String>):
    required: true
    

    The name of the key pair to delete.

    
    
  • expected_fingerprint(impl Into<String>) / set_expected_fingerprint(Option<String>):
    required: false
    

    The RSA fingerprint of the Lightsail default key pair to delete.

    The expectedFingerprint parameter is required only when specifying to delete a Lightsail default key pair.

    
    
• On success, responds with DeleteKeyPairOutput 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<DeleteKeyPairError>

impl Client

pub fn delete_known_host_keys(&self) -> DeleteKnownHostKeysFluentBuilder

Constructs a fluent builder for the DeleteKnownHostKeys operation.

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

    The name of the instance for which you want to reset the host key or certificate.

    
    
• On success, responds with DeleteKnownHostKeysOutput 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<DeleteKnownHostKeysError>

impl Client

pub fn delete_load_balancer(&self) -> DeleteLoadBalancerFluentBuilder

Constructs a fluent builder for the DeleteLoadBalancer operation.

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

    The name of the load balancer you want to delete.

    
    
• On success, responds with DeleteLoadBalancerOutput 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<DeleteLoadBalancerError>

impl Client

pub fn delete_load_balancer_tls_certificate( &self, ) -> DeleteLoadBalancerTlsCertificateFluentBuilder

Constructs a fluent builder for the DeleteLoadBalancerTlsCertificate operation.

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

    The load balancer name.

    
    
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: true
    

    The SSL/TLS certificate name.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    When true, forces the deletion of an SSL/TLS certificate.

    There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.

    
    
• On success, responds with DeleteLoadBalancerTlsCertificateOutput 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<DeleteLoadBalancerTlsCertificateError>

impl Client

pub fn delete_relational_database( &self, ) -> DeleteRelationalDatabaseFluentBuilder

Constructs a fluent builder for the DeleteRelationalDatabase operation.

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

    The name of the database that you are deleting.

    
    
  • skip_final_snapshot(bool) / set_skip_final_snapshot(Option<bool>):
    required: false
    

    Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted.

    You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.

    Default: false

    
    
  • final_relational_database_snapshot_name(impl Into<String>) / set_final_relational_database_snapshot_name(Option<String>):
    required: false
    

    The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.

    Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error.

    Constraints:

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

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

    
    
• On success, responds with DeleteRelationalDatabaseOutput 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<DeleteRelationalDatabaseError>

impl Client

pub fn delete_relational_database_snapshot( &self, ) -> DeleteRelationalDatabaseSnapshotFluentBuilder

Constructs a fluent builder for the DeleteRelationalDatabaseSnapshot operation.

• The fluent builder is configurable:
  • relational_database_snapshot_name(impl Into<String>) / set_relational_database_snapshot_name(Option<String>):
    required: true
    

    The name of the database snapshot that you are deleting.

    
    
• On success, responds with DeleteRelationalDatabaseSnapshotOutput 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<DeleteRelationalDatabaseSnapshotError>

impl Client

pub fn detach_certificate_from_distribution( &self, ) -> DetachCertificateFromDistributionFluentBuilder

Constructs a fluent builder for the DetachCertificateFromDistribution operation.

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

    The name of the distribution from which to detach the certificate.

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

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

    An object that describes 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<DetachCertificateFromDistributionError>

impl Client

pub fn detach_disk(&self) -> DetachDiskFluentBuilder

Constructs a fluent builder for the DetachDisk operation.

• The fluent builder is configurable:
  • disk_name(impl Into<String>) / set_disk_name(Option<String>):
    required: true
    

    The unique name of the disk you want to detach from your instance (my-disk).

    
    
• On success, responds with DetachDiskOutput 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<DetachDiskError>

impl Client

pub fn detach_instances_from_load_balancer( &self, ) -> DetachInstancesFromLoadBalancerFluentBuilder

Constructs a fluent builder for the DetachInstancesFromLoadBalancer operation.

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

    The name of the Lightsail load balancer.

    
    
  • instance_names(impl Into<String>) / set_instance_names(Option<Vec::<String>>):
    required: true
    

    An array of strings containing the names of the instances you want to detach from the load balancer.

    
    
• On success, responds with DetachInstancesFromLoadBalancerOutput 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<DetachInstancesFromLoadBalancerError>

impl Client

pub fn detach_static_ip(&self) -> DetachStaticIpFluentBuilder

Constructs a fluent builder for the DetachStaticIp operation.

• The fluent builder is configurable:
  • static_ip_name(impl Into<String>) / set_static_ip_name(Option<String>):
    required: true
    

    The name of the static IP to detach from the instance.

    
    
• On success, responds with DetachStaticIpOutput 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<DetachStaticIpError>

impl Client

pub fn disable_add_on(&self) -> DisableAddOnFluentBuilder

Constructs a fluent builder for the DisableAddOn operation.

• The fluent builder is configurable:
  • add_on_type(AddOnType) / set_add_on_type(Option<AddOnType>):
    required: true
    

    The add-on type to disable.

    
    
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the source resource for which to disable the add-on.

    
    
• On success, responds with DisableAddOnOutput 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<DisableAddOnError>

impl Client

pub fn download_default_key_pair(&self) -> DownloadDefaultKeyPairFluentBuilder

Constructs a fluent builder for the DownloadDefaultKeyPair operation.

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

    A base64-encoded public key of the ssh-rsa type.

  • private_key_base64(Option<String>):

    A base64-encoded RSA private key.

  • created_at(Option<DateTime>):

    The timestamp when the default key pair was created.

• On failure, responds with SdkError<DownloadDefaultKeyPairError>

impl Client

pub fn enable_add_on(&self) -> EnableAddOnFluentBuilder

Constructs a fluent builder for the EnableAddOn operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the source resource for which to enable or modify the add-on.

    
    
  • add_on_request(AddOnRequest) / set_add_on_request(Option<AddOnRequest>):
    required: true
    

    An array of strings representing the add-on to enable or modify.

    
    
• On success, responds with EnableAddOnOutput 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<EnableAddOnError>

impl Client

pub fn export_snapshot(&self) -> ExportSnapshotFluentBuilder

Constructs a fluent builder for the ExportSnapshot operation.

• The fluent builder is configurable:
  • source_snapshot_name(impl Into<String>) / set_source_snapshot_name(Option<String>):
    required: true
    

    The name of the instance or disk snapshot to be exported to Amazon EC2.

    
    
• On success, responds with ExportSnapshotOutput 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<ExportSnapshotError>

impl Client

pub fn get_active_names(&self) -> GetActiveNamesFluentBuilder

Constructs a fluent builder for the GetActiveNames operation.

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

    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>

impl Client

pub fn get_alarms(&self) -> GetAlarmsFluentBuilder

Constructs a fluent builder for the GetAlarms operation.

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

    The name of the alarm.

    Specify an alarm name to return information about a specific alarm.

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

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

    To get a page token, perform an initial GetAlarms 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.

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

    The name of the Lightsail resource being monitored by the alarm.

    Specify a monitored resource name to return information about all alarms for a specific resource.

    
    
• On success, responds with GetAlarmsOutput with field(s):
  • alarms(Option<Vec::<Alarm>>):

    An array of objects that describe the alarms.

  • 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 GetAlarms request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetAlarmsError>

impl Client

pub fn get_auto_snapshots(&self) -> GetAutoSnapshotsFluentBuilder

Constructs a fluent builder for the GetAutoSnapshots operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the source instance or disk from which to get automatic snapshot information.

    
    
• On success, responds with GetAutoSnapshotsOutput with field(s):
  • resource_name(Option<String>):

    The name of the source instance or disk for the automatic snapshots.

  • resource_type(Option<ResourceType>):

    The resource type of the automatic snapshot. The possible values are Instance, and Disk.

  • auto_snapshots(Option<Vec::<AutoSnapshotDetails>>):

    An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.

• On failure, responds with SdkError<GetAutoSnapshotsError>

impl Client

pub fn get_blueprints(&self) -> GetBlueprintsFluentBuilder

Constructs a fluent builder for the GetBlueprints operation.

• The fluent builder is configurable:
  • include_inactive(bool) / set_include_inactive(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to include inactive (unavailable) blueprints in the response of your request.

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

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

    To get a page token, perform an initial GetBlueprints 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.

    
    
  • app_category(AppCategory) / set_app_category(Option<AppCategory>):
    required: false
    

    Returns a list of blueprints that are specific to Lightsail for Research.

    You must use this parameter to view Lightsail for Research blueprints.

    
    
• On success, responds with GetBlueprintsOutput with field(s):
  • blueprints(Option<Vec::<Blueprint>>):

    An array of key-value pairs that contains information about the available blueprints.

  • 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 GetBlueprints request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetBlueprintsError>

impl Client

pub fn get_bucket_access_keys(&self) -> GetBucketAccessKeysFluentBuilder

Constructs a fluent builder for the GetBucketAccessKeys operation.

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

    The name of the bucket for which to return access keys.

    
    
• On success, responds with GetBucketAccessKeysOutput with field(s):
  • access_keys(Option<Vec::<AccessKey>>):

    An object that describes the access keys for the specified bucket.

• On failure, responds with SdkError<GetBucketAccessKeysError>

impl Client

pub fn get_bucket_bundles(&self) -> GetBucketBundlesFluentBuilder

Constructs a fluent builder for the GetBucketBundles operation.

• The fluent builder is configurable:
  • include_inactive(bool) / set_include_inactive(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

    
    
• On success, responds with GetBucketBundlesOutput with field(s):
  • bundles(Option<Vec::<BucketBundle>>):

    An object that describes bucket bundles.

• On failure, responds with SdkError<GetBucketBundlesError>

impl Client

pub fn get_bucket_metric_data(&self) -> GetBucketMetricDataFluentBuilder

Constructs a fluent builder for the GetBucketMetricData operation.

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

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

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

    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>):
    required: true
    

    The timestamp indicating the earliest data to be returned.

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

    The timestamp indicating the latest data to be returned.

    
    
  • period(i32) / set_period(Option<i32>):
    required: true
    

    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(MetricStatistic) / set_statistics(Option<Vec::<MetricStatistic>>):
    required: true
    

    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>):
    required: true
    

    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):
  • metric_name(Option<BucketMetricName>):

    The name of the metric returned.

  • metric_data(Option<Vec::<MetricDatapoint>>):

    An array of objects that describe the metric data returned.

• On failure, responds with SdkError<GetBucketMetricDataError>

impl Client

pub fn get_buckets(&self) -> GetBucketsFluentBuilder

Constructs a fluent builder for the GetBuckets operation.

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

    The name of the bucket for which to return information.

    When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.

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

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

    To get a page token, perform an initial GetBuckets 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.

    
    
  • include_connected_resources(bool) / set_include_connected_resources(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

    
    
  • include_cors(bool) / set_include_cors(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to include Lightsail bucket CORS configuration in the response. For more information, see Configuring cross-origin resource sharing (CORS).

    This parameter is only supported when getting a single bucket with bucketName specified. The default value for this parameter is False.

    
    
• On success, responds with GetBucketsOutput with field(s):
  • buckets(Option<Vec::<Bucket>>):

    An array of objects that describe buckets.

  • 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 GetBuckets request and specify the next page token using the pageToken parameter.

  • account_level_bpa_sync(Option<AccountLevelBpaSync>):

    An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.

    For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

• On failure, responds with SdkError<GetBucketsError>

impl Client

pub fn get_bundles(&self) -> GetBundlesFluentBuilder

Constructs a fluent builder for the GetBundles operation.

• The fluent builder is configurable:
  • include_inactive(bool) / set_include_inactive(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

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

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

    To get a page token, perform an initial GetBundles 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.

    
    
  • app_category(AppCategory) / set_app_category(Option<AppCategory>):
    required: false
    

    Returns a list of bundles that are specific to Lightsail for Research.

    You must use this parameter to view Lightsail for Research bundles.

    
    
• On success, responds with GetBundlesOutput with field(s):
  • bundles(Option<Vec::<Bundle>>):

    An array of key-value pairs that contains information about the available bundles.

  • 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 GetBundles request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetBundlesError>

impl Client

pub fn get_certificates(&self) -> GetCertificatesFluentBuilder

Constructs a fluent builder for the GetCertificates operation.

• The fluent builder is configurable:
  • certificate_statuses(CertificateStatus) / set_certificate_statuses(Option<Vec::<CertificateStatus>>):
    required: false
    

    The status of the certificates for which to return information.

    For example, specify ISSUED to return only certificates with an ISSUED status.

    When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

    
    
  • include_certificate_details(bool) / set_include_certificate_details(Option<bool>):
    required: false
    

    Indicates whether to include detailed information about the certificates in the response.

    When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

    
    
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: false
    

    The name for the certificate for which to return information.

    When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

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

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

    To get a page token, perform an initial GetCertificates 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 GetCertificatesOutput with field(s):
  • certificates(Option<Vec::<CertificateSummary>>):

    An object that describes certificates.

  • next_page_token(Option<String>):

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

• On failure, responds with SdkError<GetCertificatesError>

impl Client

pub fn get_cloud_formation_stack_records( &self, ) -> GetCloudFormationStackRecordsFluentBuilder

Constructs a fluent builder for the GetCloudFormationStackRecords operation.

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

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

    To get a page token, perform an initial GetClouFormationStackRecords 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 GetCloudFormationStackRecordsOutput with field(s):
  • cloud_formation_stack_records(Option<Vec::<CloudFormationStackRecord>>):

    A list of objects describing the CloudFormation stack records.

  • 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 GetCloudFormationStackRecords request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetCloudFormationStackRecordsError>

impl Client

pub fn get_contact_methods(&self) -> GetContactMethodsFluentBuilder

Constructs a fluent builder for the GetContactMethods operation.

• The fluent builder is configurable:
  • protocols(ContactProtocol) / set_protocols(Option<Vec::<ContactProtocol>>):
    required: false
    

    The protocols used to send notifications, such as Email, or SMS (text messaging).

    Specify a protocol in your request to return information about a specific contact method protocol.

    
    
• On success, responds with GetContactMethodsOutput with field(s):
  • contact_methods(Option<Vec::<ContactMethod>>):

    An array of objects that describe the contact methods.

• On failure, responds with SdkError<GetContactMethodsError>

impl Client

pub fn get_container_api_metadata(&self) -> GetContainerAPIMetadataFluentBuilder

Constructs a fluent builder for the GetContainerAPIMetadata operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetContainerApiMetadataOutput with field(s):
  • metadata(Option<Vec::<HashMap::<String, String>>>):

    Metadata about Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.

• On failure, responds with SdkError<GetContainerAPIMetadataError>

impl Client

pub fn get_container_images(&self) -> GetContainerImagesFluentBuilder

Constructs a fluent builder for the GetContainerImages operation.

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

    The name of the container service for which to return registered container images.

    
    
• On success, responds with GetContainerImagesOutput with field(s):
  • container_images(Option<Vec::<ContainerImage>>):

    An array of objects that describe container images that are registered to the container service.

• On failure, responds with SdkError<GetContainerImagesError>

impl Client

pub fn get_container_log(&self) -> GetContainerLogFluentBuilder

Constructs a fluent builder for the GetContainerLog operation.

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

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

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

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn get_container_service_deployments( &self, ) -> GetContainerServiceDeploymentsFluentBuilder

Constructs a fluent builder for the GetContainerServiceDeployments operation.

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

    The name of the container service for which to return deployments.

    
    
• On success, responds with GetContainerServiceDeploymentsOutput with field(s):
  • deployments(Option<Vec::<ContainerServiceDeployment>>):

    An array of objects that describe deployments for a container service.

• On failure, responds with SdkError<GetContainerServiceDeploymentsError>

impl Client

pub fn get_container_service_metric_data( &self, ) -> GetContainerServiceMetricDataFluentBuilder

Constructs a fluent builder for the GetContainerServiceMetricData operation.

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

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

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

    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>):
    required: true
    

    The start time of the time period.

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

    The end time of the time period.

    
    
  • period(i32) / set_period(Option<i32>):
    required: true
    

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

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

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

    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):
  • metric_name(Option<ContainerServiceMetricName>):

    The name of the metric returned.

  • metric_data(Option<Vec::<MetricDatapoint>>):

    An array of objects that describe the metric data returned.

• On failure, responds with SdkError<GetContainerServiceMetricDataError>

impl Client

pub fn get_container_service_powers( &self, ) -> GetContainerServicePowersFluentBuilder

Constructs a fluent builder for the GetContainerServicePowers operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetContainerServicePowersOutput with field(s):
  • powers(Option<Vec::<ContainerServicePower>>):

    An array of objects that describe the powers that can be specified for a container service.

• On failure, responds with SdkError<GetContainerServicePowersError>

impl Client

pub fn get_container_services(&self) -> GetContainerServicesFluentBuilder

Constructs a fluent builder for the GetContainerServices operation.

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

    The name of the container service for which to return information.

    When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

    
    
• On success, responds with GetContainerServicesOutput with field(s):
  • container_services(Option<Vec::<ContainerService>>):

    An array of objects that describe one or more container services.

• On failure, responds with SdkError<GetContainerServicesError>

impl Client

pub fn get_cost_estimate(&self) -> GetCostEstimateFluentBuilder

Constructs a fluent builder for the GetCostEstimate operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The resource name.

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

    The cost estimate start time.

    Constraints:

    • Specified in Coordinated Universal Time (UTC).

    • Specified in the Unix time format.

      For example, if you want 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>):
    required: true
    

    The cost estimate end time.

    Constraints:

    • Specified in Coordinated Universal Time (UTC).

    • Specified in the Unix time format.

      For example, if you want 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.

    
    
• On success, responds with GetCostEstimateOutput with field(s):
  • resources_budget_estimate(Option<Vec::<ResourceBudgetEstimate>>):

    Returns the estimate’s forecasted cost or usage.

• On failure, responds with SdkError<GetCostEstimateError>

impl Client

pub fn get_disk(&self) -> GetDiskFluentBuilder

Constructs a fluent builder for the GetDisk operation.

• The fluent builder is configurable:
  • disk_name(impl Into<String>) / set_disk_name(Option<String>):
    required: true
    

    The name of the disk (my-disk).

    
    
• On success, responds with GetDiskOutput with field(s):
  • disk(Option<Disk>):

    An object containing information about the disk.

• On failure, responds with SdkError<GetDiskError>

impl Client

pub fn get_disk_snapshot(&self) -> GetDiskSnapshotFluentBuilder

Constructs a fluent builder for the GetDiskSnapshot operation.

• The fluent builder is configurable:
  • disk_snapshot_name(impl Into<String>) / set_disk_snapshot_name(Option<String>):
    required: true
    

    The name of the disk snapshot (my-disk-snapshot).

    
    
• On success, responds with GetDiskSnapshotOutput with field(s):
  • disk_snapshot(Option<DiskSnapshot>):

    An object containing information about the disk snapshot.

• On failure, responds with SdkError<GetDiskSnapshotError>

impl Client

pub fn get_disk_snapshots(&self) -> GetDiskSnapshotsFluentBuilder

Constructs a fluent builder for the GetDiskSnapshots operation.

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

    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>

impl Client

pub fn get_disks(&self) -> GetDisksFluentBuilder

Constructs a fluent builder for the GetDisks operation.

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

    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>

impl Client

pub fn get_distribution_bundles(&self) -> GetDistributionBundlesFluentBuilder

Constructs a fluent builder for the GetDistributionBundles operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetDistributionBundlesOutput with field(s):
  • bundles(Option<Vec::<DistributionBundle>>):

    An object that describes a distribution bundle.

• On failure, responds with SdkError<GetDistributionBundlesError>

impl Client

pub fn get_distribution_latest_cache_reset( &self, ) -> GetDistributionLatestCacheResetFluentBuilder

Constructs a fluent builder for the GetDistributionLatestCacheReset operation.

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

    The name of the distribution for which to return the timestamp of the last cache reset.

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

    When omitted, the response includes the latest cache reset timestamp of all your distributions.

    
    
• On success, responds with GetDistributionLatestCacheResetOutput with field(s):
  • status(Option<String>):

    The status of the last cache reset.

  • create_time(Option<DateTime>):

    The timestamp of the last cache reset (1479734909.17) in Unix time format.

• On failure, responds with SdkError<GetDistributionLatestCacheResetError>

impl Client

pub fn get_distribution_metric_data( &self, ) -> GetDistributionMetricDataFluentBuilder

Constructs a fluent builder for the GetDistributionMetricData operation.

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

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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(Option<i32>):
    required: true
    

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

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

    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(MetricStatistic) / set_statistics(Option<Vec::<MetricStatistic>>):
    required: true
    

    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):
  • metric_name(Option<DistributionMetricName>):

    The name of the metric returned.

  • metric_data(Option<Vec::<MetricDatapoint>>):

    An array of objects that describe the metric data returned.

• On failure, responds with SdkError<GetDistributionMetricDataError>

impl Client

pub fn get_distributions(&self) -> GetDistributionsFluentBuilder

Constructs a fluent builder for the GetDistributions operation.

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

    The name of the distribution for which to return information.

    When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.

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

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

    To get a page token, perform an initial GetDistributions 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 GetDistributionsOutput with field(s):
  • distributions(Option<Vec::<LightsailDistribution>>):

    An array of objects that describe your distributions.

  • 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 GetDistributions request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetDistributionsError>

impl Client

pub fn get_domain(&self) -> GetDomainFluentBuilder

Constructs a fluent builder for the GetDomain operation.

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

    The domain name for which your want to return information about.

    
    
• On success, responds with GetDomainOutput with field(s):
  • domain(Option<Domain>):

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

• On failure, responds with SdkError<GetDomainError>

impl Client

pub fn get_domains(&self) -> GetDomainsFluentBuilder

Constructs a fluent builder for the GetDomains operation.

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

    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>

impl Client

pub fn get_export_snapshot_records( &self, ) -> GetExportSnapshotRecordsFluentBuilder

Constructs a fluent builder for the GetExportSnapshotRecords operation.

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

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

    To get a page token, perform an initial GetExportSnapshotRecords 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 GetExportSnapshotRecordsOutput with field(s):
  • export_snapshot_records(Option<Vec::<ExportSnapshotRecord>>):

    A list of objects describing the export snapshot records.

  • 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 GetExportSnapshotRecords request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetExportSnapshotRecordsError>

impl Client

pub fn get_instance(&self) -> GetInstanceFluentBuilder

Constructs a fluent builder for the GetInstance operation.

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

    The name of the instance.

    
    
• On success, responds with GetInstanceOutput with field(s):
  • instance(Option<Instance>):

    An array of key-value pairs containing information about the specified instance.

• On failure, responds with SdkError<GetInstanceError>

impl Client

pub fn get_instance_access_details( &self, ) -> GetInstanceAccessDetailsFluentBuilder

Constructs a fluent builder for the GetInstanceAccessDetails operation.

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

    The name of the instance to access.

    
    
  • protocol(InstanceAccessProtocol) / set_protocol(Option<InstanceAccessProtocol>):
    required: false
    

    The protocol to use to connect to your instance. Defaults to ssh.

    
    
• On success, responds with GetInstanceAccessDetailsOutput with field(s):
  • access_details(Option<InstanceAccessDetails>):

    An array of key-value pairs containing information about a get instance access request.

• On failure, responds with SdkError<GetInstanceAccessDetailsError>

impl Client

pub fn get_instance_metric_data(&self) -> GetInstanceMetricDataFluentBuilder

Constructs a fluent builder for the GetInstanceMetricData operation.

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

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

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

    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.

    • MetadataNoToken - Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn’t use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.

      Statistics: The most useful statistic is Sum.

      Unit: The published unit is Count.

    
    
  • period(i32) / set_period(Option<i32>):
    required: true
    

    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>):
    required: true
    

    The start time of the time period.

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

    The end time of the time period.

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

    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(MetricStatistic) / set_statistics(Option<Vec::<MetricStatistic>>):
    required: true
    

    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):
  • metric_name(Option<InstanceMetricName>):

    The name of the metric returned.

  • metric_data(Option<Vec::<MetricDatapoint>>):

    An array of objects that describe the metric data returned.

• On failure, responds with SdkError<GetInstanceMetricDataError>

impl Client

pub fn get_instance_port_states(&self) -> GetInstancePortStatesFluentBuilder

Constructs a fluent builder for the GetInstancePortStates operation.

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

    The name of the instance for which to return firewall port states.

    
    
• On success, responds with GetInstancePortStatesOutput with field(s):
  • port_states(Option<Vec::<InstancePortState>>):

    An array of objects that describe the firewall port states for the specified instance.

• On failure, responds with SdkError<GetInstancePortStatesError>

impl Client

pub fn get_instance_snapshot(&self) -> GetInstanceSnapshotFluentBuilder

Constructs a fluent builder for the GetInstanceSnapshot operation.

• The fluent builder is configurable:
  • instance_snapshot_name(impl Into<String>) / set_instance_snapshot_name(Option<String>):
    required: true
    

    The name of the snapshot for which you are requesting information.

    
    
• On success, responds with GetInstanceSnapshotOutput with field(s):
  • instance_snapshot(Option<InstanceSnapshot>):

    An array of key-value pairs containing information about the results of your get instance snapshot request.

• On failure, responds with SdkError<GetInstanceSnapshotError>

impl Client

pub fn get_instance_snapshots(&self) -> GetInstanceSnapshotsFluentBuilder

Constructs a fluent builder for the GetInstanceSnapshots operation.

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

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

    To get a page token, perform an initial GetInstanceSnapshots 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 GetInstanceSnapshotsOutput with field(s):
  • instance_snapshots(Option<Vec::<InstanceSnapshot>>):

    An array of key-value pairs containing information about the results of your get instance snapshots 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 GetInstanceSnapshots request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetInstanceSnapshotsError>

impl Client

pub fn get_instance_state(&self) -> GetInstanceStateFluentBuilder

Constructs a fluent builder for the GetInstanceState operation.

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

    The name of the instance to get state information about.

    
    
• On success, responds with GetInstanceStateOutput with field(s):
  • state(Option<InstanceState>):

    The state of the instance.

• On failure, responds with SdkError<GetInstanceStateError>

impl Client

pub fn get_instances(&self) -> GetInstancesFluentBuilder

Constructs a fluent builder for the GetInstances operation.

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

    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>

impl Client

pub fn get_key_pair(&self) -> GetKeyPairFluentBuilder

Constructs a fluent builder for the GetKeyPair operation.

• The fluent builder is configurable:
  • key_pair_name(impl Into<String>) / set_key_pair_name(Option<String>):
    required: true
    

    The name of the key pair for which you are requesting information.

    
    
• On success, responds with GetKeyPairOutput with field(s):
  • key_pair(Option<KeyPair>):

    An array of key-value pairs containing information about the key pair.

• On failure, responds with SdkError<GetKeyPairError>

impl Client

pub fn get_key_pairs(&self) -> GetKeyPairsFluentBuilder

Constructs a fluent builder for the GetKeyPairs operation.

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

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

    To get a page token, perform an initial GetKeyPairs 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.

    
    
  • include_default_key_pair(bool) / set_include_default_key_pair(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to include the default key pair in the response of your request.

    
    
• On success, responds with GetKeyPairsOutput with field(s):
  • key_pairs(Option<Vec::<KeyPair>>):

    An array of key-value pairs containing information about the key pairs.

  • 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 GetKeyPairs request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetKeyPairsError>

impl Client

pub fn get_load_balancer(&self) -> GetLoadBalancerFluentBuilder

Constructs a fluent builder for the GetLoadBalancer operation.

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

    The name of the load balancer.

    
    
• On success, responds with GetLoadBalancerOutput with field(s):
  • load_balancer(Option<LoadBalancer>):

    An object containing information about your load balancer.

• On failure, responds with SdkError<GetLoadBalancerError>

impl Client

pub fn get_load_balancer_metric_data( &self, ) -> GetLoadBalancerMetricDataFluentBuilder

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>):
    required: true
    

    The name of the load balancer.

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

    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(Option<i32>):
    required: true
    

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

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

    The start time of the period.

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

    The end time of the period.

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

    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(MetricStatistic) / set_statistics(Option<Vec::<MetricStatistic>>):
    required: true
    

    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):
  • metric_name(Option<LoadBalancerMetricName>):

    The name of the metric returned.

  • metric_data(Option<Vec::<MetricDatapoint>>):

    An array of objects that describe the metric data returned.

• On failure, responds with SdkError<GetLoadBalancerMetricDataError>

impl Client

pub fn get_load_balancer_tls_certificates( &self, ) -> GetLoadBalancerTlsCertificatesFluentBuilder

Constructs a fluent builder for the GetLoadBalancerTlsCertificates operation.

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

    The name of the load balancer you associated with your SSL/TLS certificate.

    
    
• On success, responds with GetLoadBalancerTlsCertificatesOutput with field(s):
  • tls_certificates(Option<Vec::<LoadBalancerTlsCertificate>>):

    An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.

• On failure, responds with SdkError<GetLoadBalancerTlsCertificatesError>

impl Client

pub fn get_load_balancer_tls_policies( &self, ) -> GetLoadBalancerTlsPoliciesFluentBuilder

Constructs a fluent builder for the GetLoadBalancerTlsPolicies operation.

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

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

    To get a page token, perform an initial GetLoadBalancerTlsPolicies 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 GetLoadBalancerTlsPoliciesOutput with field(s):
  • tls_policies(Option<Vec::<LoadBalancerTlsPolicy>>):

    An array of objects that describe the TLS security policies that are available.

  • 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 GetLoadBalancerTlsPolicies request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetLoadBalancerTlsPoliciesError>

impl Client

pub fn get_load_balancers(&self) -> GetLoadBalancersFluentBuilder

Constructs a fluent builder for the GetLoadBalancers operation.

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

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

    To get a page token, perform an initial GetLoadBalancers 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 GetLoadBalancersOutput with field(s):
  • load_balancers(Option<Vec::<LoadBalancer>>):

    An array of LoadBalancer objects describing your load balancers.

  • 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 GetLoadBalancers request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetLoadBalancersError>

impl Client

pub fn get_operation(&self) -> GetOperationFluentBuilder

Constructs a fluent builder for the GetOperation operation.

• The fluent builder is configurable:
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

    A GUID used to identify the operation.

    
    
• On success, responds with GetOperationOutput 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<GetOperationError>

impl Client

pub fn get_operations(&self) -> GetOperationsFluentBuilder

Constructs a fluent builder for the GetOperations operation.

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

    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>

impl Client

pub fn get_operations_for_resource( &self, ) -> GetOperationsForResourceFluentBuilder

Constructs a fluent builder for the GetOperationsForResource operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the resource for which you are requesting information.

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

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

    To get a page token, perform an initial GetOperationsForResource 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 GetOperationsForResourceOutput 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_count(Option<String>):

    (Discontinued) Returns the number of pages of results that remain.

    In releases prior to June 12, 2017, this parameter returned null by the API. It is now discontinued, and the API returns the next page token parameter instead.

  • 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 GetOperationsForResource request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetOperationsForResourceError>

impl Client

pub fn get_regions(&self) -> GetRegionsFluentBuilder

Constructs a fluent builder for the GetRegions operation.

• The fluent builder is configurable:
  • include_availability_zones(bool) / set_include_availability_zones(Option<bool>):
    required: false
    

    A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: us-east-2a.

    
    
  • include_relational_database_availability_zones(bool) / set_include_relational_database_availability_zones(Option<bool>):
    required: false
    

    A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (us-east-2a).

    
    
• On success, responds with GetRegionsOutput with field(s):
  • regions(Option<Vec::<Region>>):

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

• On failure, responds with SdkError<GetRegionsError>

impl Client

pub fn get_relational_database(&self) -> GetRelationalDatabaseFluentBuilder

Constructs a fluent builder for the GetRelationalDatabase operation.

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

    The name of the database that you are looking up.

    
    
• On success, responds with GetRelationalDatabaseOutput with field(s):
  • relational_database(Option<RelationalDatabase>):

    An object describing the specified database.

• On failure, responds with SdkError<GetRelationalDatabaseError>

impl Client

pub fn get_relational_database_blueprints( &self, ) -> GetRelationalDatabaseBlueprintsFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseBlueprints operation.

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

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

    To get a page token, perform an initial GetRelationalDatabaseBlueprints 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 GetRelationalDatabaseBlueprintsOutput with field(s):
  • blueprints(Option<Vec::<RelationalDatabaseBlueprint>>):

    An object describing the result of your get relational database blueprints 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 GetRelationalDatabaseBlueprints request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetRelationalDatabaseBlueprintsError>

impl Client

pub fn get_relational_database_bundles( &self, ) -> GetRelationalDatabaseBundlesFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseBundles operation.

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

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

    To get a page token, perform an initial GetRelationalDatabaseBundles 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.

    
    
  • include_inactive(bool) / set_include_inactive(Option<bool>):
    required: false
    

    A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

    
    
• On success, responds with GetRelationalDatabaseBundlesOutput with field(s):
  • bundles(Option<Vec::<RelationalDatabaseBundle>>):

    An object describing the result of your get relational database bundles 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 GetRelationalDatabaseBundles request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetRelationalDatabaseBundlesError>

impl Client

pub fn get_relational_database_events( &self, ) -> GetRelationalDatabaseEventsFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseEvents operation.

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

    The name of the database from which to get events.

    
    
  • duration_in_minutes(i32) / set_duration_in_minutes(Option<i32>):
    required: false
    

    The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.

    Default: 60

    The minimum is 1 and the maximum is 14 days (20160 minutes).

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

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

    To get a page token, perform an initial GetRelationalDatabaseEvents 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 GetRelationalDatabaseEventsOutput with field(s):
  • relational_database_events(Option<Vec::<RelationalDatabaseEvent>>):

    An object describing the result of your get relational database events 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 GetRelationalDatabaseEvents request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetRelationalDatabaseEventsError>

impl Client

pub fn get_relational_database_log_events( &self, ) -> GetRelationalDatabaseLogEventsFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseLogEvents operation.

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

    The name of your database for which to get log events.

    
    
  • log_stream_name(impl Into<String>) / set_log_stream_name(Option<String>):
    required: true
    

    The name of the log stream.

    Use the get relational database log streams operation to get a list of available log streams.

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

    The start of the time interval from which to get log events.

    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>):
    required: false
    

    The end of the time interval from which to get log events.

    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.

    
    
  • start_from_head(bool) / set_start_from_head(Option<bool>):
    required: false
    

    Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

    For PostgreSQL, the default value of false is the only option available.

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

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

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

    
    
• On success, responds with GetRelationalDatabaseLogEventsOutput with field(s):
  • resource_log_events(Option<Vec::<LogEvent>>):

    An object describing the result of your get relational database log events request.

  • next_backward_token(Option<String>):

    A token used for advancing to the previous page of results from your get relational database log events request.

  • next_forward_token(Option<String>):

    A token used for advancing to the next page of results from your get relational database log events request.

• On failure, responds with SdkError<GetRelationalDatabaseLogEventsError>

impl Client

pub fn get_relational_database_log_streams( &self, ) -> GetRelationalDatabaseLogStreamsFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseLogStreams operation.

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

    The name of your database for which to get log streams.

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

    An object describing the result of your get relational database log streams request.

• On failure, responds with SdkError<GetRelationalDatabaseLogStreamsError>

impl Client

pub fn get_relational_database_master_user_password( &self, ) -> GetRelationalDatabaseMasterUserPasswordFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseMasterUserPassword operation.

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

    The name of your database for which to get the master user password.

    
    
  • password_version(RelationalDatabasePasswordVersion) / set_password_version(Option<RelationalDatabasePasswordVersion>):
    required: false
    

    The password version to return.

    Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available.

    Default: CURRENT

    
    
• On success, responds with GetRelationalDatabaseMasterUserPasswordOutput with field(s):
  • master_user_password(Option<String>):

    The master user password for the password version specified.

  • created_at(Option<DateTime>):

    The timestamp when the specified version of the master user password was created.

• On failure, responds with SdkError<GetRelationalDatabaseMasterUserPasswordError>

impl Client

pub fn get_relational_database_metric_data( &self, ) -> GetRelationalDatabaseMetricDataFluentBuilder

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>):
    required: true
    

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

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

    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(Option<i32>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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(MetricStatistic) / set_statistics(Option<Vec::<MetricStatistic>>):
    required: true
    

    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):
  • metric_name(Option<RelationalDatabaseMetricName>):

    The name of the metric returned.

  • metric_data(Option<Vec::<MetricDatapoint>>):

    An array of objects that describe the metric data returned.

• On failure, responds with SdkError<GetRelationalDatabaseMetricDataError>

impl Client

pub fn get_relational_database_parameters( &self, ) -> GetRelationalDatabaseParametersFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseParameters operation.

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

    The name of your database for which to get parameters.

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

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

    To get a page token, perform an initial GetRelationalDatabaseParameters 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 GetRelationalDatabaseParametersOutput with field(s):
  • parameters(Option<Vec::<RelationalDatabaseParameter>>):

    An object describing the result of your get relational database parameters 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 GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetRelationalDatabaseParametersError>

impl Client

pub fn get_relational_database_snapshot( &self, ) -> GetRelationalDatabaseSnapshotFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseSnapshot operation.

• The fluent builder is configurable:
  • relational_database_snapshot_name(impl Into<String>) / set_relational_database_snapshot_name(Option<String>):
    required: true
    

    The name of the database snapshot for which to get information.

    
    
• On success, responds with GetRelationalDatabaseSnapshotOutput with field(s):
  • relational_database_snapshot(Option<RelationalDatabaseSnapshot>):

    An object describing the specified database snapshot.

• On failure, responds with SdkError<GetRelationalDatabaseSnapshotError>

impl Client

pub fn get_relational_database_snapshots( &self, ) -> GetRelationalDatabaseSnapshotsFluentBuilder

Constructs a fluent builder for the GetRelationalDatabaseSnapshots operation.

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

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

    To get a page token, perform an initial GetRelationalDatabaseSnapshots 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 GetRelationalDatabaseSnapshotsOutput with field(s):
  • relational_database_snapshots(Option<Vec::<RelationalDatabaseSnapshot>>):

    An object describing the result of your get relational database snapshots 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 GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetRelationalDatabaseSnapshotsError>

impl Client

pub fn get_relational_databases(&self) -> GetRelationalDatabasesFluentBuilder

Constructs a fluent builder for the GetRelationalDatabases operation.

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

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

    To get a page token, perform an initial GetRelationalDatabases 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 GetRelationalDatabasesOutput with field(s):
  • relational_databases(Option<Vec::<RelationalDatabase>>):

    An object describing the result of your get relational databases 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 GetRelationalDatabases request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetRelationalDatabasesError>

impl Client

pub fn get_setup_history(&self) -> GetSetupHistoryFluentBuilder

Constructs a fluent builder for the GetSetupHistory operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the resource for which you are requesting information.

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

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

    To get a page token, perform an initial GetSetupHistory 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 GetSetupHistoryOutput with field(s):
  • setup_history(Option<Vec::<SetupHistory>>):

    The historical information that’s returned.

  • 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 GetSetupHistory request and specify the next page token using the pageToken parameter.

• On failure, responds with SdkError<GetSetupHistoryError>

impl Client

pub fn get_static_ip(&self) -> GetStaticIpFluentBuilder

Constructs a fluent builder for the GetStaticIp operation.

• The fluent builder is configurable:
  • static_ip_name(impl Into<String>) / set_static_ip_name(Option<String>):
    required: true
    

    The name of the static IP in Lightsail.

    
    
• On success, responds with GetStaticIpOutput with field(s):
  • static_ip(Option<StaticIp>):

    An array of key-value pairs containing information about the requested static IP.

• On failure, responds with SdkError<GetStaticIpError>

impl Client

pub fn get_static_ips(&self) -> GetStaticIpsFluentBuilder

Constructs a fluent builder for the GetStaticIps operation.

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

    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>

impl Client

pub fn import_key_pair(&self) -> ImportKeyPairFluentBuilder

Constructs a fluent builder for the ImportKeyPair operation.

• The fluent builder is configurable:
  • key_pair_name(impl Into<String>) / set_key_pair_name(Option<String>):
    required: true
    

    The name of the key pair for which you want to import the public key.

    
    
  • public_key_base64(impl Into<String>) / set_public_key_base64(Option<String>):
    required: true
    

    A base64-encoded public key of the ssh-rsa type.

    
    
• On success, responds with ImportKeyPairOutput 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<ImportKeyPairError>

impl Client

pub fn is_vpc_peered(&self) -> IsVpcPeeredFluentBuilder

Constructs a fluent builder for the IsVpcPeered operation.

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

    Returns true if the Lightsail VPC is peered; otherwise, false.

• On failure, responds with SdkError<IsVpcPeeredError>

impl Client

pub fn open_instance_public_ports(&self) -> OpenInstancePublicPortsFluentBuilder

Constructs a fluent builder for the OpenInstancePublicPorts operation.

• The fluent builder is configurable:
  • port_info(PortInfo) / set_port_info(Option<PortInfo>):
    required: true
    

    An object to describe the ports to open for the specified instance.

    
    
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: true
    

    The name of the instance for which to open ports.

    
    
• On success, responds with OpenInstancePublicPortsOutput 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<OpenInstancePublicPortsError>

impl Client

pub fn peer_vpc(&self) -> PeerVpcFluentBuilder

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>

impl Client

pub fn put_alarm(&self) -> PutAlarmFluentBuilder

Constructs a fluent builder for the PutAlarm operation.

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

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    The value against which the specified statistic is compared.

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

    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>):
    required: false
    

    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>):
    required: false
    

    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(ContactProtocol) / set_contact_protocols(Option<Vec::<ContactProtocol>>):
    required: false
    

    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(AlarmState) / set_notification_triggers(Option<Vec::<AlarmState>>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn put_instance_public_ports(&self) -> PutInstancePublicPortsFluentBuilder

Constructs a fluent builder for the PutInstancePublicPorts operation.

• The fluent builder is configurable:
  • port_infos(PortInfo) / set_port_infos(Option<Vec::<PortInfo>>):
    required: true
    

    An array of objects to describe the ports to open for the specified instance.

    
    
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: true
    

    The name of the instance for which to open ports.

    
    
• On success, responds with PutInstancePublicPortsOutput 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<PutInstancePublicPortsError>

impl Client

pub fn reboot_instance(&self) -> RebootInstanceFluentBuilder

Constructs a fluent builder for the RebootInstance operation.

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

    The name of the instance to reboot.

    
    
• On success, responds with RebootInstanceOutput 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<RebootInstanceError>

impl Client

pub fn reboot_relational_database( &self, ) -> RebootRelationalDatabaseFluentBuilder

Constructs a fluent builder for the RebootRelationalDatabase operation.

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

    The name of your database to reboot.

    
    
• On success, responds with RebootRelationalDatabaseOutput 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<RebootRelationalDatabaseError>

impl Client

pub fn register_container_image(&self) -> RegisterContainerImageFluentBuilder

Constructs a fluent builder for the RegisterContainerImage operation.

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

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

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

    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>):
    required: true
    

    The digest of the container image to be registered.

    
    
• On success, responds with RegisterContainerImageOutput with field(s):
  • container_image(Option<ContainerImage>):

    An object that describes a container image that is registered to a Lightsail container service

• On failure, responds with SdkError<RegisterContainerImageError>

impl Client

pub fn release_static_ip(&self) -> ReleaseStaticIpFluentBuilder

Constructs a fluent builder for the ReleaseStaticIp operation.

• The fluent builder is configurable:
  • static_ip_name(impl Into<String>) / set_static_ip_name(Option<String>):
    required: true
    

    The name of the static IP to delete.

    
    
• On success, responds with ReleaseStaticIpOutput 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<ReleaseStaticIpError>

impl Client

pub fn reset_distribution_cache(&self) -> ResetDistributionCacheFluentBuilder

Constructs a fluent builder for the ResetDistributionCache operation.

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

    The name of the distribution for which to reset cache.

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

    
    
• On success, responds with ResetDistributionCacheOutput with field(s):
  • status(Option<String>):

    The status of the reset cache request.

  • create_time(Option<DateTime>):

    The timestamp of the reset cache request (1479734909.17) in Unix time format.

  • 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<ResetDistributionCacheError>

impl Client

pub fn send_contact_method_verification( &self, ) -> SendContactMethodVerificationFluentBuilder

Constructs a fluent builder for the SendContactMethodVerification operation.

• The fluent builder is configurable:
  • protocol(ContactMethodVerificationProtocol) / set_protocol(Option<ContactMethodVerificationProtocol>):
    required: true
    

    The protocol to verify, such as Email or SMS (text messaging).

    
    
• On success, responds with SendContactMethodVerificationOutput 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<SendContactMethodVerificationError>

impl Client

pub fn set_ip_address_type(&self) -> SetIpAddressTypeFluentBuilder

Constructs a fluent builder for the SetIpAddressType operation.

• The fluent builder is configurable:
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: true
    

    The resource type.

    The resource values are Distribution, Instance, and LoadBalancer.

    Distribution-related APIs are available only in the N. Virginia (us-east-1) Amazon Web Services Region. Set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit distributions.

    
    
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the resource for which to set the IP address type.

    
    
  • ip_address_type(IpAddressType) / set_ip_address_type(Option<IpAddressType>):
    required: true
    

    The IP address type to set for the specified resource.

    The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

    
    
  • accept_bundle_update(bool) / set_accept_bundle_update(Option<bool>):
    required: false
    

    Required parameter to accept the instance bundle update when changing to, and from, IPv6-only.

    An instance bundle will change when switching from dual-stack or ipv4, to ipv6. It also changes when switching from ipv6, to dual-stack or ipv4.

    You must include this parameter in the command to update the bundle. For example, if you switch from dual-stack to ipv6, the bundle will be updated, and billing for the IPv6-only instance bundle begins immediately.

    
    
• On success, responds with SetIpAddressTypeOutput 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<SetIpAddressTypeError>

impl Client

pub fn set_resource_access_for_bucket( &self, ) -> SetResourceAccessForBucketFluentBuilder

Constructs a fluent builder for the SetResourceAccessForBucket operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.

    
    
  • bucket_name(impl Into<String>) / set_bucket_name(Option<String>):
    required: true
    

    The name of the bucket for which to set access to another Lightsail resource.

    
    
  • access(ResourceBucketAccess) / set_access(Option<ResourceBucketAccess>):
    required: true
    

    The access setting.

    The following access settings are available:

    • allow - Allows access to the bucket and its objects.

    • deny - Denies access to the bucket and its objects. Use this setting to remove access for a resource previously set to allow.

    
    
• On success, responds with SetResourceAccessForBucketOutput 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<SetResourceAccessForBucketError>

impl Client

pub fn setup_instance_https(&self) -> SetupInstanceHttpsFluentBuilder

Constructs a fluent builder for the SetupInstanceHttps operation.

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

    The name of the Lightsail instance.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: true
    

    The contact method for SSL/TLS certificate renewal alerts. You can enter one email address.

    
    
  • domain_names(impl Into<String>) / set_domain_names(Option<Vec::<String>>):
    required: true
    

    The name of the domain and subdomains that were specified for the SSL/TLS certificate.

    
    
  • certificate_provider(CertificateProvider) / set_certificate_provider(Option<CertificateProvider>):
    required: true
    

    The certificate authority that issues the SSL/TLS certificate.

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

    The available API operations for SetupInstanceHttps.

• On failure, responds with SdkError<SetupInstanceHttpsError>

impl Client

pub fn start_gui_session(&self) -> StartGUISessionFluentBuilder

Constructs a fluent builder for the StartGUISession operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The resource name.

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

    The available API operations.

• On failure, responds with SdkError<StartGUISessionError>

impl Client

pub fn start_instance(&self) -> StartInstanceFluentBuilder

Constructs a fluent builder for the StartInstance operation.

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

    The name of the instance (a virtual private server) to start.

    
    
• On success, responds with StartInstanceOutput 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<StartInstanceError>

impl Client

pub fn start_relational_database(&self) -> StartRelationalDatabaseFluentBuilder

Constructs a fluent builder for the StartRelationalDatabase operation.

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

    The name of your database to start.

    
    
• On success, responds with StartRelationalDatabaseOutput 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<StartRelationalDatabaseError>

impl Client

pub fn stop_gui_session(&self) -> StopGUISessionFluentBuilder

Constructs a fluent builder for the StopGUISession operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The resource name.

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

    The available API operations.

• On failure, responds with SdkError<StopGUISessionError>

impl Client

pub fn stop_instance(&self) -> StopInstanceFluentBuilder

Constructs a fluent builder for the StopInstance operation.

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

    The name of the instance (a virtual private server) to stop.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

    Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

    
    
• On success, responds with StopInstanceOutput 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<StopInstanceError>

impl Client

pub fn stop_relational_database(&self) -> StopRelationalDatabaseFluentBuilder

Constructs a fluent builder for the StopRelationalDatabase operation.

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

    The name of your database to stop.

    
    
  • relational_database_snapshot_name(impl Into<String>) / set_relational_database_snapshot_name(Option<String>):
    required: false
    

    The name of your new database snapshot to be created before stopping your database.

    
    
• On success, responds with StopRelationalDatabaseOutput 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<StopRelationalDatabaseError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the resource to which you are adding tags.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

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

    The tag key and optional value.

    
    
• On success, responds with TagResourceOutput 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<TagResourceError>

impl Client

pub fn test_alarm(&self) -> TestAlarmFluentBuilder

Constructs a fluent builder for the TestAlarm operation.

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

    The name of the alarm to test.

    
    
  • state(AlarmState) / set_state(Option<AlarmState>):
    required: true
    

    The alarm state to test.

    An alarm has the following possible states that can be tested:

    • 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.

    
    
• On success, responds with TestAlarmOutput 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<TestAlarmError>

impl Client

pub fn unpeer_vpc(&self) -> UnpeerVpcFluentBuilder

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>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_name(impl Into<String>) / set_resource_name(Option<String>):
    required: true
    

    The name of the resource from which you are removing a tag.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys to delete from the specified resource.

    
    
• On success, responds with UntagResourceOutput 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<UntagResourceError>

impl Client

pub fn update_bucket(&self) -> UpdateBucketFluentBuilder

Constructs a fluent builder for the UpdateBucket operation.

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

    The name of the bucket to update.

    
    
  • access_rules(AccessRules) / set_access_rules(Option<AccessRules>):
    required: false
    

    An object that sets the public accessibility of objects in the specified bucket.

    
    
  • versioning(impl Into<String>) / set_versioning(Option<String>):
    required: false
    

    Specifies whether to enable or suspend versioning of objects in the bucket.

    The following options can be specified:

    • Enabled - Enables versioning of objects in the specified bucket.

    • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.

    
    
  • readonly_access_accounts(impl Into<String>) / set_readonly_access_accounts(Option<Vec::<String>>):
    required: false
    

    An array of strings to specify the Amazon Web Services account IDs that can access the bucket.

    You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

    
    
  • access_log_config(BucketAccessLogConfig) / set_access_log_config(Option<BucketAccessLogConfig>):
    required: false
    

    An object that describes the access log configuration for the bucket.

    
    
  • cors(BucketCorsConfig) / set_cors(Option<BucketCorsConfig>):
    required: false
    

    Sets the cross-origin resource sharing (CORS) configuration for your bucket. If a CORS configuration exists, it is replaced with the specified configuration. For AWS CLI operations, this parameter can also be passed as a file. For more information, see Configuring cross-origin resource sharing (CORS).

    CORS information is only returned in a response when you update the CORS policy.

    
    
• On success, responds with UpdateBucketOutput with field(s):
  • bucket(Option<Bucket>):

    An object that describes the bucket that is updated.

  • 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<UpdateBucketError>

impl Client

pub fn update_bucket_bundle(&self) -> UpdateBucketBundleFluentBuilder

Constructs a fluent builder for the UpdateBucketBundle operation.

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

    The name of the bucket for which to update the bundle.

    
    
  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):
    required: true
    

    The ID of the new bundle to apply to the bucket.

    Use the GetBucketBundles action to get a list of bundle IDs that you can specify.

    
    
• On success, responds with UpdateBucketBundleOutput 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<UpdateBucketBundleError>

impl Client

pub fn update_container_service(&self) -> UpdateContainerServiceFluentBuilder

Constructs a fluent builder for the UpdateContainerService operation.

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

    The name of the container service to update.

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

    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>):
    required: false
    

    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>):
    required: false
    

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

    
    
  • public_domain_names(impl Into<String>, Vec::<String>) / set_public_domain_names(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    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.

    
    
  • private_registry_access(PrivateRegistryAccessRequest) / set_private_registry_access(Option<PrivateRegistryAccessRequest>):
    required: false
    

    An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

    For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

    
    
• On success, responds with UpdateContainerServiceOutput with field(s):
  • container_service(Option<ContainerService>):

    An object that describes a container service.

• On failure, responds with SdkError<UpdateContainerServiceError>

impl Client

pub fn update_distribution(&self) -> UpdateDistributionFluentBuilder

Constructs a fluent builder for the UpdateDistribution operation.

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

    The name of the distribution to update.

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

    
    
  • origin(InputOrigin) / set_origin(Option<InputOrigin>):
    required: false
    

    An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

    The distribution pulls, caches, and serves content from the origin.

    
    
  • default_cache_behavior(CacheBehavior) / set_default_cache_behavior(Option<CacheBehavior>):
    required: false
    

    An object that describes the default cache behavior for the distribution.

    
    
  • cache_behavior_settings(CacheSettings) / set_cache_behavior_settings(Option<CacheSettings>):
    required: false
    

    An object that describes the cache behavior settings for the distribution.

    The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution’s existing settings.

    
    
  • cache_behaviors(CacheBehaviorPerPath) / set_cache_behaviors(Option<Vec::<CacheBehaviorPerPath>>):
    required: false
    

    An array of objects that describe the per-path cache behavior for the distribution.

    
    
  • is_enabled(bool) / set_is_enabled(Option<bool>):
    required: false
    

    Indicates whether to enable the distribution.

    
    
  • viewer_minimum_tls_protocol_version(ViewerMinimumTlsProtocolVersionEnum) / set_viewer_minimum_tls_protocol_version(Option<ViewerMinimumTlsProtocolVersionEnum>):
    required: false
    

    Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that’s attached to the distribution.

    
    
  • certificate_name(impl Into<String>) / set_certificate_name(Option<String>):
    required: false
    

    The name of the SSL/TLS certificate that you want to attach to the distribution.

    Only certificates with a status of ISSUED can be attached to a distribution.

    Use the GetCertificates action to get a list of certificate names that you can specify.

    
    
  • use_default_certificate(bool) / set_use_default_certificate(Option<bool>):
    required: false
    

    Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is true. When true, the distribution uses the default domain name such as d111111abcdef8.cloudfront.net.

    Set this value to false to attach a new certificate to the distribution.

    
    
• On success, responds with UpdateDistributionOutput 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<UpdateDistributionError>

impl Client

pub fn update_distribution_bundle( &self, ) -> UpdateDistributionBundleFluentBuilder

Constructs a fluent builder for the UpdateDistributionBundle operation.

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

    The name of the distribution for which to update the bundle.

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

    
    
  • bundle_id(impl Into<String>) / set_bundle_id(Option<String>):
    required: false
    

    The bundle ID of the new bundle to apply to your distribution.

    Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.

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

    An object that describes 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<UpdateDistributionBundleError>

impl Client

pub fn update_domain_entry(&self) -> UpdateDomainEntryFluentBuilder

Constructs a fluent builder for the UpdateDomainEntry operation.

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

    The name of the domain recordset to update.

    
    
  • domain_entry(DomainEntry) / set_domain_entry(Option<DomainEntry>):
    required: true
    

    An array of key-value pairs containing information about the domain entry.

    
    
• On success, responds with UpdateDomainEntryOutput 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<UpdateDomainEntryError>

impl Client

pub fn update_instance_metadata_options( &self, ) -> UpdateInstanceMetadataOptionsFluentBuilder

Constructs a fluent builder for the UpdateInstanceMetadataOptions operation.

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

    The name of the instance for which to update metadata parameters.

    
    
  • http_tokens(HttpTokens) / set_http_tokens(Option<HttpTokens>):
    required: false
    

    The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

    If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

    If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

    
    
  • http_endpoint(HttpEndpoint) / set_http_endpoint(Option<HttpEndpoint>):
    required: false
    

    Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

    If you specify a value of disabled, you cannot access your instance metadata.

    
    
  • http_put_response_hop_limit(i32) / set_http_put_response_hop_limit(Option<i32>):
    required: false
    

    The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

    
    
  • http_protocol_ipv6(HttpProtocolIpv6) / set_http_protocol_ipv6(Option<HttpProtocolIpv6>):
    required: false
    

    Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

    This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

    
    
• On success, responds with UpdateInstanceMetadataOptionsOutput 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<UpdateInstanceMetadataOptionsError>

impl Client

pub fn update_load_balancer_attribute( &self, ) -> UpdateLoadBalancerAttributeFluentBuilder

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>):
    required: true
    

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

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

    The name of the attribute you want to update.

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

    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 to activate session stickiness or false to deactivate session stickiness.

    • 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 to activate HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.

    • If you specify TlsPolicyName for the attributeName request parameter, then the attributeValue request parameter must be the name of the TLS policy.

      Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

    
    
• 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>

impl Client

pub fn update_relational_database( &self, ) -> UpdateRelationalDatabaseFluentBuilder

Constructs a fluent builder for the UpdateRelationalDatabase operation.

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

    The name of your Lightsail database resource to update.

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

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

    MySQL

    Constraints: Must contain from 8 to 41 characters.

    PostgreSQL

    Constraints: Must contain from 8 to 128 characters.

    
    
  • rotate_master_user_password(bool) / set_rotate_master_user_password(Option<bool>):
    required: false
    

    When true, the master user password is changed to a new strong password generated by Lightsail.

    Use the get relational database master user password operation to get the new password.

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

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

    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>):
    required: false
    

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

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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

    
    
  • enable_backup_retention(bool) / set_enable_backup_retention(Option<bool>):
    required: false
    

    When true, enables automated backup retention for your database.

    Updates are applied during the next maintenance window because this can result in an outage.

    
    
  • disable_backup_retention(bool) / set_disable_backup_retention(Option<bool>):
    required: false
    

    When true, disables automated backup retention for your database.

    Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

    Updates are applied during the next maintenance window because this can result in an outage.

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

    Specifies the accessibility options for your 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.

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: false
    

    When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

    Default: false

    
    
  • ca_certificate_identifier(impl Into<String>) / set_ca_certificate_identifier(Option<String>):
    required: false
    

    Indicates the certificate that needs to be associated with the database.

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

    This parameter is used to update the major version of the database. Enter the blueprintId for the major version that you want to update to.

    Use the GetRelationalDatabaseBlueprints action to get a list of available blueprint IDs.

    
    
• On success, responds with UpdateRelationalDatabaseOutput 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<UpdateRelationalDatabaseError>

impl Client

pub fn update_relational_database_parameters( &self, ) -> UpdateRelationalDatabaseParametersFluentBuilder

Constructs a fluent builder for the UpdateRelationalDatabaseParameters operation.

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

    The name of your database for which to update parameters.

    
    
  • parameters(RelationalDatabaseParameter) / set_parameters(Option<Vec::<RelationalDatabaseParameter>>):
    required: true
    

    The database parameters to update.

    
    
• On success, responds with UpdateRelationalDatabaseParametersOutput 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<UpdateRelationalDatabaseParametersError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.