amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.Lens

Contents

Description

 
Synopsis

Operations

AllocateStaticIp

allocateStaticIp_staticIpName :: Lens' AllocateStaticIp Text Source #

The name of the static IP address.

allocateStaticIpResponse_operations :: Lens' AllocateStaticIpResponse (Maybe [Operation]) Source #

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.

allocateStaticIpResponse_httpStatus :: Lens' AllocateStaticIpResponse Int Source #

The response's http status code.

AttachCertificateToDistribution

attachCertificateToDistribution_distributionName :: Lens' AttachCertificateToDistribution Text Source #

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.

attachCertificateToDistribution_certificateName :: Lens' AttachCertificateToDistribution Text Source #

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.

attachCertificateToDistributionResponse_operation :: Lens' AttachCertificateToDistributionResponse (Maybe Operation) Source #

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.

attachCertificateToDistributionResponse_httpStatus :: Lens' AttachCertificateToDistributionResponse Int Source #

The response's http status code.

AttachDisk

attachDisk_diskName :: Lens' AttachDisk Text Source #

The unique Lightsail disk name (e.g., my-disk).

attachDisk_instanceName :: Lens' AttachDisk Text Source #

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

attachDisk_diskPath :: Lens' AttachDisk Text Source #

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

attachDiskResponse_operations :: Lens' AttachDiskResponse (Maybe [Operation]) Source #

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.

attachDiskResponse_httpStatus :: Lens' AttachDiskResponse Int Source #

The response's http status code.

AttachInstancesToLoadBalancer

attachInstancesToLoadBalancer_loadBalancerName :: Lens' AttachInstancesToLoadBalancer Text Source #

The name of the load balancer.

attachInstancesToLoadBalancer_instanceNames :: Lens' AttachInstancesToLoadBalancer [Text] Source #

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).

attachInstancesToLoadBalancerResponse_operations :: Lens' AttachInstancesToLoadBalancerResponse (Maybe [Operation]) Source #

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.

attachInstancesToLoadBalancerResponse_httpStatus :: Lens' AttachInstancesToLoadBalancerResponse Int Source #

The response's http status code.

AttachLoadBalancerTlsCertificate

attachLoadBalancerTlsCertificate_loadBalancerName :: Lens' AttachLoadBalancerTlsCertificate Text Source #

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

attachLoadBalancerTlsCertificate_certificateName :: Lens' AttachLoadBalancerTlsCertificate Text Source #

The name of your SSL/TLS certificate.

attachLoadBalancerTlsCertificateResponse_operations :: Lens' AttachLoadBalancerTlsCertificateResponse (Maybe [Operation]) Source #

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.

attachLoadBalancerTlsCertificateResponse_httpStatus :: Lens' AttachLoadBalancerTlsCertificateResponse Int Source #

The response's http status code.

AttachStaticIp

attachStaticIp_staticIpName :: Lens' AttachStaticIp Text Source #

The name of the static IP.

attachStaticIp_instanceName :: Lens' AttachStaticIp Text Source #

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

attachStaticIpResponse_operations :: Lens' AttachStaticIpResponse (Maybe [Operation]) Source #

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.

attachStaticIpResponse_httpStatus :: Lens' AttachStaticIpResponse Int Source #

The response's http status code.

CloseInstancePublicPorts

closeInstancePublicPorts_portInfo :: Lens' CloseInstancePublicPorts PortInfo Source #

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

closeInstancePublicPorts_instanceName :: Lens' CloseInstancePublicPorts Text Source #

The name of the instance for which to close ports.

closeInstancePublicPortsResponse_operation :: Lens' CloseInstancePublicPortsResponse (Maybe Operation) Source #

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.

closeInstancePublicPortsResponse_httpStatus :: Lens' CloseInstancePublicPortsResponse Int Source #

The response's http status code.

CopySnapshot

copySnapshot_restoreDate :: Lens' CopySnapshot (Maybe Text) Source #

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.

copySnapshot_sourceResourceName :: Lens' CopySnapshot (Maybe Text) Source #

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

Constraint:

copySnapshot_sourceSnapshotName :: Lens' CopySnapshot (Maybe Text) Source #

The name of the source manual snapshot to copy.

Constraint:

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

copySnapshot_useLatestRestorableAutoSnapshot :: Lens' CopySnapshot (Maybe Bool) Source #

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.

copySnapshot_targetSnapshotName :: Lens' CopySnapshot Text Source #

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

copySnapshot_sourceRegion :: Lens' CopySnapshot RegionName Source #

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

copySnapshotResponse_operations :: Lens' CopySnapshotResponse (Maybe [Operation]) Source #

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.

copySnapshotResponse_httpStatus :: Lens' CopySnapshotResponse Int Source #

The response's http status code.

CreateBucket

createBucket_enableObjectVersioning :: Lens' CreateBucket (Maybe Bool) Source #

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.

createBucket_tags :: Lens' CreateBucket (Maybe [Tag]) Source #

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.

createBucket_bucketName :: Lens' CreateBucket Text Source #

The name for the bucket.

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

createBucket_bundleId :: Lens' CreateBucket Text Source #

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.

createBucketResponse_bucket :: Lens' CreateBucketResponse (Maybe Bucket) Source #

An object that describes the bucket that is created.

createBucketResponse_operations :: Lens' CreateBucketResponse (Maybe [Operation]) Source #

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.

createBucketResponse_httpStatus :: Lens' CreateBucketResponse Int Source #

The response's http status code.

CreateBucketAccessKey

createBucketAccessKey_bucketName :: Lens' CreateBucketAccessKey Text Source #

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

createBucketAccessKeyResponse_accessKey :: Lens' CreateBucketAccessKeyResponse (Maybe AccessKey) Source #

An object that describes the access key that is created.

createBucketAccessKeyResponse_operations :: Lens' CreateBucketAccessKeyResponse (Maybe [Operation]) Source #

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.

createBucketAccessKeyResponse_httpStatus :: Lens' CreateBucketAccessKeyResponse Int Source #

The response's http status code.

CreateCertificate

createCertificate_subjectAlternativeNames :: Lens' CreateCertificate (Maybe [Text]) Source #

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., 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 (e.g., *.example.com) are not supported.

createCertificate_tags :: Lens' CreateCertificate (Maybe [Tag]) Source #

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.

createCertificate_certificateName :: Lens' CreateCertificate Text Source #

The name for the certificate.

createCertificate_domainName :: Lens' CreateCertificate Text Source #

The domain name (e.g., example.com) for the certificate.

createCertificateResponse_certificate :: Lens' CreateCertificateResponse (Maybe CertificateSummary) Source #

An object that describes the certificate created.

createCertificateResponse_operations :: Lens' CreateCertificateResponse (Maybe [Operation]) Source #

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.

createCertificateResponse_httpStatus :: Lens' CreateCertificateResponse Int Source #

The response's http status code.

CreateCloudFormationStack

createCloudFormationStack_instances :: Lens' CreateCloudFormationStack [InstanceEntry] Source #

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.

createCloudFormationStackResponse_operations :: Lens' CreateCloudFormationStackResponse (Maybe [Operation]) Source #

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.

createCloudFormationStackResponse_httpStatus :: Lens' CreateCloudFormationStackResponse Int Source #

The response's http status code.

CreateContactMethod

createContactMethod_protocol :: Lens' CreateContactMethod ContactProtocol Source #

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.

createContactMethod_contactEndpoint :: Lens' CreateContactMethod Text Source #

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.

createContactMethodResponse_operations :: Lens' CreateContactMethodResponse (Maybe [Operation]) Source #

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.

createContactMethodResponse_httpStatus :: Lens' CreateContactMethodResponse Int Source #

The response's http status code.

CreateContainerService

createContainerService_deployment :: Lens' CreateContainerService (Maybe ContainerServiceDeploymentRequest) Source #

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.

createContainerService_privateRegistryAccess :: Lens' CreateContainerService (Maybe PrivateRegistryAccessRequest) Source #

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.

createContainerService_publicDomainNames :: Lens' CreateContainerService (Maybe (HashMap Text [Text])) Source #

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.

createContainerService_tags :: Lens' CreateContainerService (Maybe [Tag]) Source #

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.

createContainerService_serviceName :: Lens' CreateContainerService Text Source #

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://<ServiceName>.<RandomGUID>.<AWSRegion>.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.

createContainerService_power :: Lens' CreateContainerService ContainerServicePowerName Source #

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.

createContainerService_scale :: Lens' CreateContainerService Natural Source #

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.

createContainerServiceResponse_containerService :: Lens' CreateContainerServiceResponse (Maybe ContainerService) Source #

An object that describes a container service.

createContainerServiceResponse_httpStatus :: Lens' CreateContainerServiceResponse Int Source #

The response's http status code.

CreateContainerServiceDeployment

createContainerServiceDeployment_containers :: Lens' CreateContainerServiceDeployment (Maybe (HashMap Text Container)) Source #

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

createContainerServiceDeployment_publicEndpoint :: Lens' CreateContainerServiceDeployment (Maybe EndpointRequest) Source #

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

createContainerServiceDeployment_serviceName :: Lens' CreateContainerServiceDeployment Text Source #

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

createContainerServiceDeploymentResponse_containerService :: Lens' CreateContainerServiceDeploymentResponse (Maybe ContainerService) Source #

An object that describes a container service.

createContainerServiceDeploymentResponse_httpStatus :: Lens' CreateContainerServiceDeploymentResponse Int Source #

The response's http status code.

CreateContainerServiceRegistryLogin

createContainerServiceRegistryLoginResponse_registryLogin :: Lens' CreateContainerServiceRegistryLoginResponse (Maybe ContainerServiceRegistryLogin) Source #

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

createContainerServiceRegistryLoginResponse_httpStatus :: Lens' CreateContainerServiceRegistryLoginResponse Int Source #

The response's http status code.

CreateDisk

createDisk_addOns :: Lens' CreateDisk (Maybe [AddOnRequest]) Source #

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

createDisk_tags :: Lens' CreateDisk (Maybe [Tag]) Source #

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.

createDisk_diskName :: Lens' CreateDisk Text Source #

The unique Lightsail disk name (e.g., my-disk).

createDisk_availabilityZone :: Lens' CreateDisk Text Source #

The Availability Zone where you want to create the disk (e.g., 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.

createDisk_sizeInGb :: Lens' CreateDisk Int Source #

The size of the disk in GB (e.g., 32).

createDiskResponse_operations :: Lens' CreateDiskResponse (Maybe [Operation]) Source #

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.

createDiskResponse_httpStatus :: Lens' CreateDiskResponse Int Source #

The response's http status code.

CreateDiskFromSnapshot

createDiskFromSnapshot_addOns :: Lens' CreateDiskFromSnapshot (Maybe [AddOnRequest]) Source #

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

createDiskFromSnapshot_diskSnapshotName :: Lens' CreateDiskFromSnapshot (Maybe Text) Source #

The name of the disk snapshot (e.g., 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.

createDiskFromSnapshot_restoreDate :: Lens' CreateDiskFromSnapshot (Maybe Text) Source #

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.

createDiskFromSnapshot_sourceDiskName :: Lens' CreateDiskFromSnapshot (Maybe Text) Source #

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.

createDiskFromSnapshot_tags :: Lens' CreateDiskFromSnapshot (Maybe [Tag]) Source #

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.

createDiskFromSnapshot_useLatestRestorableAutoSnapshot :: Lens' CreateDiskFromSnapshot (Maybe Bool) Source #

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.

createDiskFromSnapshot_diskName :: Lens' CreateDiskFromSnapshot Text Source #

The unique Lightsail disk name (e.g., my-disk).

createDiskFromSnapshot_availabilityZone :: Lens' CreateDiskFromSnapshot Text Source #

The Availability Zone where you want to create the disk (e.g., 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.

createDiskFromSnapshot_sizeInGb :: Lens' CreateDiskFromSnapshot Int Source #

The size of the disk in GB (e.g., 32).

createDiskFromSnapshotResponse_operations :: Lens' CreateDiskFromSnapshotResponse (Maybe [Operation]) Source #

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.

createDiskFromSnapshotResponse_httpStatus :: Lens' CreateDiskFromSnapshotResponse Int Source #

The response's http status code.

CreateDiskSnapshot

createDiskSnapshot_diskName :: Lens' CreateDiskSnapshot (Maybe Text) Source #

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

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

createDiskSnapshot_instanceName :: Lens' CreateDiskSnapshot (Maybe Text) Source #

The unique name of the source instance (e.g., 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.

createDiskSnapshot_tags :: Lens' CreateDiskSnapshot (Maybe [Tag]) Source #

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.

createDiskSnapshot_diskSnapshotName :: Lens' CreateDiskSnapshot Text Source #

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

createDiskSnapshotResponse_operations :: Lens' CreateDiskSnapshotResponse (Maybe [Operation]) Source #

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.

createDiskSnapshotResponse_httpStatus :: Lens' CreateDiskSnapshotResponse Int Source #

The response's http status code.

CreateDistribution

createDistribution_cacheBehaviorSettings :: Lens' CreateDistribution (Maybe CacheSettings) Source #

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

createDistribution_cacheBehaviors :: Lens' CreateDistribution (Maybe [CacheBehaviorPerPath]) Source #

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

createDistribution_ipAddressType :: Lens' CreateDistribution (Maybe IpAddressType) Source #

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.

createDistribution_tags :: Lens' CreateDistribution (Maybe [Tag]) Source #

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.

createDistribution_distributionName :: Lens' CreateDistribution Text Source #

The name for the distribution.

createDistribution_origin :: Lens' CreateDistribution InputOrigin Source #

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.

createDistribution_defaultCacheBehavior :: Lens' CreateDistribution CacheBehavior Source #

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

createDistribution_bundleId :: Lens' CreateDistribution Text Source #

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.

createDistributionResponse_distribution :: Lens' CreateDistributionResponse (Maybe LightsailDistribution) Source #

An object that describes the distribution created.

createDistributionResponse_operation :: Lens' CreateDistributionResponse (Maybe Operation) Source #

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.

createDistributionResponse_httpStatus :: Lens' CreateDistributionResponse Int Source #

The response's http status code.

CreateDomain

createDomain_tags :: Lens' CreateDomain (Maybe [Tag]) Source #

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.

createDomain_domainName :: Lens' CreateDomain Text Source #

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

createDomainResponse_operation :: Lens' CreateDomainResponse (Maybe Operation) Source #

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.

createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #

The response's http status code.

CreateDomainEntry

createDomainEntry_domainName :: Lens' CreateDomainEntry Text Source #

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

createDomainEntry_domainEntry :: Lens' CreateDomainEntry DomainEntry Source #

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

createDomainEntryResponse_operation :: Lens' CreateDomainEntryResponse (Maybe Operation) Source #

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.

createDomainEntryResponse_httpStatus :: Lens' CreateDomainEntryResponse Int Source #

The response's http status code.

CreateInstanceSnapshot

createInstanceSnapshot_tags :: Lens' CreateInstanceSnapshot (Maybe [Tag]) Source #

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.

createInstanceSnapshot_instanceSnapshotName :: Lens' CreateInstanceSnapshot Text Source #

The name for your new snapshot.

createInstanceSnapshot_instanceName :: Lens' CreateInstanceSnapshot Text Source #

The Lightsail instance on which to base your snapshot.

createInstanceSnapshotResponse_operations :: Lens' CreateInstanceSnapshotResponse (Maybe [Operation]) Source #

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.

createInstanceSnapshotResponse_httpStatus :: Lens' CreateInstanceSnapshotResponse Int Source #

The response's http status code.

CreateInstances

createInstances_addOns :: Lens' CreateInstances (Maybe [AddOnRequest]) Source #

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

createInstances_customImageName :: Lens' CreateInstances (Maybe Text) Source #

(Deprecated) The name for your custom image.

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

createInstances_ipAddressType :: Lens' CreateInstances (Maybe IpAddressType) Source #

The IP address type for the instance.

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

The default value is dualstack.

createInstances_keyPairName :: Lens' CreateInstances (Maybe Text) Source #

The name of your key pair.

createInstances_tags :: Lens' CreateInstances (Maybe [Tag]) Source #

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.

createInstances_userData :: Lens' CreateInstances (Maybe Text) Source #

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.

createInstances_instanceNames :: Lens' CreateInstances [Text] Source #

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

createInstances_availabilityZone :: Lens' CreateInstances Text Source #

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.

createInstances_blueprintId :: Lens' CreateInstances Text Source #

The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). 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.

createInstances_bundleId :: Lens' CreateInstances Text Source #

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

createInstancesResponse_operations :: Lens' CreateInstancesResponse (Maybe [Operation]) Source #

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.

createInstancesResponse_httpStatus :: Lens' CreateInstancesResponse Int Source #

The response's http status code.

CreateInstancesFromSnapshot

createInstancesFromSnapshot_addOns :: Lens' CreateInstancesFromSnapshot (Maybe [AddOnRequest]) Source #

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

createInstancesFromSnapshot_attachedDiskMapping :: Lens' CreateInstancesFromSnapshot (Maybe (HashMap Text [DiskMap])) Source #

An object containing information about one or more disk mappings.

createInstancesFromSnapshot_instanceSnapshotName :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

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.

createInstancesFromSnapshot_ipAddressType :: Lens' CreateInstancesFromSnapshot (Maybe IpAddressType) Source #

The IP address type for the instance.

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

The default value is dualstack.

createInstancesFromSnapshot_keyPairName :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

The name for your key pair.

createInstancesFromSnapshot_restoreDate :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

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.

createInstancesFromSnapshot_sourceInstanceName :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

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.

createInstancesFromSnapshot_tags :: Lens' CreateInstancesFromSnapshot (Maybe [Tag]) Source #

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.

createInstancesFromSnapshot_useLatestRestorableAutoSnapshot :: Lens' CreateInstancesFromSnapshot (Maybe Bool) Source #

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.

createInstancesFromSnapshot_userData :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

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.

createInstancesFromSnapshot_instanceNames :: Lens' CreateInstancesFromSnapshot [Text] Source #

The names for your new instances.

createInstancesFromSnapshot_availabilityZone :: Lens' CreateInstancesFromSnapshot Text Source #

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.

createInstancesFromSnapshot_bundleId :: Lens' CreateInstancesFromSnapshot Text Source #

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

createInstancesFromSnapshotResponse_operations :: Lens' CreateInstancesFromSnapshotResponse (Maybe [Operation]) Source #

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.

createInstancesFromSnapshotResponse_httpStatus :: Lens' CreateInstancesFromSnapshotResponse Int Source #

The response's http status code.

CreateKeyPair

createKeyPair_tags :: Lens' CreateKeyPair (Maybe [Tag]) Source #

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.

createKeyPair_keyPairName :: Lens' CreateKeyPair Text Source #

The name for your new key pair.

createKeyPairResponse_keyPair :: Lens' CreateKeyPairResponse (Maybe KeyPair) Source #

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

createKeyPairResponse_operation :: Lens' CreateKeyPairResponse (Maybe Operation) Source #

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.

createKeyPairResponse_privateKeyBase64 :: Lens' CreateKeyPairResponse (Maybe Text) Source #

A base64-encoded RSA private key.

createKeyPairResponse_publicKeyBase64 :: Lens' CreateKeyPairResponse (Maybe Text) Source #

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

createKeyPairResponse_httpStatus :: Lens' CreateKeyPairResponse Int Source #

The response's http status code.

CreateLoadBalancer

createLoadBalancer_certificateAlternativeNames :: Lens' CreateLoadBalancer (Maybe [Text]) Source #

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

createLoadBalancer_certificateDomainName :: Lens' CreateLoadBalancer (Maybe Text) Source #

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

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

createLoadBalancer_certificateName :: Lens' CreateLoadBalancer (Maybe Text) Source #

The name of the SSL/TLS certificate.

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

createLoadBalancer_healthCheckPath :: Lens' CreateLoadBalancer (Maybe Text) Source #

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 (e.g., "/").

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.

createLoadBalancer_ipAddressType :: Lens' CreateLoadBalancer (Maybe IpAddressType) Source #

The IP address type for the load balancer.

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

The default value is dualstack.

createLoadBalancer_tags :: Lens' CreateLoadBalancer (Maybe [Tag]) Source #

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.

createLoadBalancer_tlsPolicyName :: Lens' CreateLoadBalancer (Maybe Text) Source #

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.

createLoadBalancer_loadBalancerName :: Lens' CreateLoadBalancer Text Source #

The name of your load balancer.

createLoadBalancer_instancePort :: Lens' CreateLoadBalancer Int Source #

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

createLoadBalancerResponse_operations :: Lens' CreateLoadBalancerResponse (Maybe [Operation]) Source #

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.

createLoadBalancerResponse_httpStatus :: Lens' CreateLoadBalancerResponse Int Source #

The response's http status code.

CreateLoadBalancerTlsCertificate

createLoadBalancerTlsCertificate_certificateAlternativeNames :: Lens' CreateLoadBalancerTlsCertificate (Maybe [Text]) Source #

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 (e.g., *.example.com).

createLoadBalancerTlsCertificate_tags :: Lens' CreateLoadBalancerTlsCertificate (Maybe [Tag]) Source #

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.

createLoadBalancerTlsCertificate_loadBalancerName :: Lens' CreateLoadBalancerTlsCertificate Text Source #

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

createLoadBalancerTlsCertificate_certificateName :: Lens' CreateLoadBalancerTlsCertificate Text Source #

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.

createLoadBalancerTlsCertificate_certificateDomainName :: Lens' CreateLoadBalancerTlsCertificate Text Source #

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

createLoadBalancerTlsCertificateResponse_operations :: Lens' CreateLoadBalancerTlsCertificateResponse (Maybe [Operation]) Source #

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.

createLoadBalancerTlsCertificateResponse_httpStatus :: Lens' CreateLoadBalancerTlsCertificateResponse Int Source #

The response's http status code.

CreateRelationalDatabase

createRelationalDatabase_availabilityZone :: Lens' CreateRelationalDatabase (Maybe Text) Source #

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.

createRelationalDatabase_masterUserPassword :: Lens' CreateRelationalDatabase (Maybe Text) Source #

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.

createRelationalDatabase_preferredBackupWindow :: Lens' CreateRelationalDatabase (Maybe Text) Source #

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.

createRelationalDatabase_preferredMaintenanceWindow :: Lens' CreateRelationalDatabase (Maybe Text) Source #

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

createRelationalDatabase_publiclyAccessible :: Lens' CreateRelationalDatabase (Maybe Bool) Source #

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.

createRelationalDatabase_tags :: Lens' CreateRelationalDatabase (Maybe [Tag]) Source #

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.

createRelationalDatabase_relationalDatabaseName :: Lens' CreateRelationalDatabase Text Source #

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.

createRelationalDatabase_relationalDatabaseBlueprintId :: Lens' CreateRelationalDatabase Text Source #

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.

createRelationalDatabase_relationalDatabaseBundleId :: Lens' CreateRelationalDatabase Text Source #

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.

createRelationalDatabase_masterDatabaseName :: Lens' CreateRelationalDatabase Text Source #

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.

createRelationalDatabase_masterUsername :: Lens' CreateRelationalDatabase Text Source #

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.

createRelationalDatabaseResponse_operations :: Lens' CreateRelationalDatabaseResponse (Maybe [Operation]) Source #

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.

createRelationalDatabaseResponse_httpStatus :: Lens' CreateRelationalDatabaseResponse Int Source #

The response's http status code.

CreateRelationalDatabaseFromSnapshot

createRelationalDatabaseFromSnapshot_availabilityZone :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Text) Source #

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.

createRelationalDatabaseFromSnapshot_publiclyAccessible :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Bool) Source #

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.

createRelationalDatabaseFromSnapshot_relationalDatabaseBundleId :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Text) Source #

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.

createRelationalDatabaseFromSnapshot_relationalDatabaseSnapshotName :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Text) Source #

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

createRelationalDatabaseFromSnapshot_restoreTime :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe UTCTime) Source #

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.

createRelationalDatabaseFromSnapshot_sourceRelationalDatabaseName :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Text) Source #

The name of the source database.

createRelationalDatabaseFromSnapshot_tags :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe [Tag]) Source #

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.

createRelationalDatabaseFromSnapshot_useLatestRestorableTime :: Lens' CreateRelationalDatabaseFromSnapshot (Maybe Bool) Source #

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.

createRelationalDatabaseFromSnapshot_relationalDatabaseName :: Lens' CreateRelationalDatabaseFromSnapshot Text Source #

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.

createRelationalDatabaseFromSnapshotResponse_operations :: Lens' CreateRelationalDatabaseFromSnapshotResponse (Maybe [Operation]) Source #

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.

createRelationalDatabaseFromSnapshotResponse_httpStatus :: Lens' CreateRelationalDatabaseFromSnapshotResponse Int Source #

The response's http status code.

CreateRelationalDatabaseSnapshot

createRelationalDatabaseSnapshot_tags :: Lens' CreateRelationalDatabaseSnapshot (Maybe [Tag]) Source #

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.

createRelationalDatabaseSnapshot_relationalDatabaseName :: Lens' CreateRelationalDatabaseSnapshot Text Source #

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

createRelationalDatabaseSnapshot_relationalDatabaseSnapshotName :: Lens' CreateRelationalDatabaseSnapshot Text Source #

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.

createRelationalDatabaseSnapshotResponse_operations :: Lens' CreateRelationalDatabaseSnapshotResponse (Maybe [Operation]) Source #

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.

createRelationalDatabaseSnapshotResponse_httpStatus :: Lens' CreateRelationalDatabaseSnapshotResponse Int Source #

The response's http status code.

DeleteAlarm

deleteAlarm_alarmName :: Lens' DeleteAlarm Text Source #

The name of the alarm to delete.

deleteAlarmResponse_operations :: Lens' DeleteAlarmResponse (Maybe [Operation]) Source #

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.

deleteAlarmResponse_httpStatus :: Lens' DeleteAlarmResponse Int Source #

The response's http status code.

DeleteAutoSnapshot

deleteAutoSnapshot_resourceName :: Lens' DeleteAutoSnapshot Text Source #

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

deleteAutoSnapshot_date :: Lens' DeleteAutoSnapshot Text Source #

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.

deleteAutoSnapshotResponse_operations :: Lens' DeleteAutoSnapshotResponse (Maybe [Operation]) Source #

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.

deleteAutoSnapshotResponse_httpStatus :: Lens' DeleteAutoSnapshotResponse Int Source #

The response's http status code.

DeleteBucket

deleteBucket_forceDelete :: Lens' DeleteBucket (Maybe Bool) Source #

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.

deleteBucket_bucketName :: Lens' DeleteBucket Text Source #

The name of the bucket to delete.

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

deleteBucketResponse_operations :: Lens' DeleteBucketResponse (Maybe [Operation]) Source #

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.

deleteBucketResponse_httpStatus :: Lens' DeleteBucketResponse Int Source #

The response's http status code.

DeleteBucketAccessKey

deleteBucketAccessKey_bucketName :: Lens' DeleteBucketAccessKey Text Source #

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

deleteBucketAccessKey_accessKeyId :: Lens' DeleteBucketAccessKey Text Source #

The ID of the access key to delete.

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

deleteBucketAccessKeyResponse_operations :: Lens' DeleteBucketAccessKeyResponse (Maybe [Operation]) Source #

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.

deleteBucketAccessKeyResponse_httpStatus :: Lens' DeleteBucketAccessKeyResponse Int Source #

The response's http status code.

DeleteCertificate

deleteCertificate_certificateName :: Lens' DeleteCertificate Text Source #

The name of the certificate to delete.

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

deleteCertificateResponse_operations :: Lens' DeleteCertificateResponse (Maybe [Operation]) Source #

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.

deleteCertificateResponse_httpStatus :: Lens' DeleteCertificateResponse Int Source #

The response's http status code.

DeleteContactMethod

deleteContactMethod_protocol :: Lens' DeleteContactMethod ContactProtocol Source #

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.

deleteContactMethodResponse_operations :: Lens' DeleteContactMethodResponse (Maybe [Operation]) Source #

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.

deleteContactMethodResponse_httpStatus :: Lens' DeleteContactMethodResponse Int Source #

The response's http status code.

DeleteContainerImage

deleteContainerImage_serviceName :: Lens' DeleteContainerImage Text Source #

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

deleteContainerImage_image :: Lens' DeleteContainerImage Text Source #

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.

deleteContainerImageResponse_httpStatus :: Lens' DeleteContainerImageResponse Int Source #

The response's http status code.

DeleteContainerService

deleteContainerService_serviceName :: Lens' DeleteContainerService Text Source #

The name of the container service to delete.

deleteContainerServiceResponse_httpStatus :: Lens' DeleteContainerServiceResponse Int Source #

The response's http status code.

DeleteDisk

deleteDisk_forceDeleteAddOns :: Lens' DeleteDisk (Maybe Bool) Source #

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

deleteDisk_diskName :: Lens' DeleteDisk Text Source #

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

deleteDiskResponse_operations :: Lens' DeleteDiskResponse (Maybe [Operation]) Source #

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.

deleteDiskResponse_httpStatus :: Lens' DeleteDiskResponse Int Source #

The response's http status code.

DeleteDiskSnapshot

deleteDiskSnapshot_diskSnapshotName :: Lens' DeleteDiskSnapshot Text Source #

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

deleteDiskSnapshotResponse_operations :: Lens' DeleteDiskSnapshotResponse (Maybe [Operation]) Source #

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.

deleteDiskSnapshotResponse_httpStatus :: Lens' DeleteDiskSnapshotResponse Int Source #

The response's http status code.

DeleteDistribution

deleteDistribution_distributionName :: Lens' DeleteDistribution (Maybe Text) Source #

The name of the distribution to delete.

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

deleteDistributionResponse_operation :: Lens' DeleteDistributionResponse (Maybe Operation) Source #

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.

deleteDistributionResponse_httpStatus :: Lens' DeleteDistributionResponse Int Source #

The response's http status code.

DeleteDomain

deleteDomain_domainName :: Lens' DeleteDomain Text Source #

The specific domain name to delete.

deleteDomainResponse_operation :: Lens' DeleteDomainResponse (Maybe Operation) Source #

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.

deleteDomainResponse_httpStatus :: Lens' DeleteDomainResponse Int Source #

The response's http status code.

DeleteDomainEntry

deleteDomainEntry_domainName :: Lens' DeleteDomainEntry Text Source #

The name of the domain entry to delete.

deleteDomainEntry_domainEntry :: Lens' DeleteDomainEntry DomainEntry Source #

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

deleteDomainEntryResponse_operation :: Lens' DeleteDomainEntryResponse (Maybe Operation) Source #

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.

deleteDomainEntryResponse_httpStatus :: Lens' DeleteDomainEntryResponse Int Source #

The response's http status code.

DeleteInstance

deleteInstance_forceDeleteAddOns :: Lens' DeleteInstance (Maybe Bool) Source #

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

deleteInstance_instanceName :: Lens' DeleteInstance Text Source #

The name of the instance to delete.

deleteInstanceResponse_operations :: Lens' DeleteInstanceResponse (Maybe [Operation]) Source #

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.

deleteInstanceResponse_httpStatus :: Lens' DeleteInstanceResponse Int Source #

The response's http status code.

DeleteInstanceSnapshot

deleteInstanceSnapshot_instanceSnapshotName :: Lens' DeleteInstanceSnapshot Text Source #

The name of the snapshot to delete.

deleteInstanceSnapshotResponse_operations :: Lens' DeleteInstanceSnapshotResponse (Maybe [Operation]) Source #

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.

deleteInstanceSnapshotResponse_httpStatus :: Lens' DeleteInstanceSnapshotResponse Int Source #

The response's http status code.

DeleteKeyPair

deleteKeyPair_expectedFingerprint :: Lens' DeleteKeyPair (Maybe Text) Source #

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.

deleteKeyPair_keyPairName :: Lens' DeleteKeyPair Text Source #

The name of the key pair to delete.

deleteKeyPairResponse_operation :: Lens' DeleteKeyPairResponse (Maybe Operation) Source #

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.

deleteKeyPairResponse_httpStatus :: Lens' DeleteKeyPairResponse Int Source #

The response's http status code.

DeleteKnownHostKeys

deleteKnownHostKeys_instanceName :: Lens' DeleteKnownHostKeys Text Source #

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

deleteKnownHostKeysResponse_operations :: Lens' DeleteKnownHostKeysResponse (Maybe [Operation]) Source #

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.

deleteKnownHostKeysResponse_httpStatus :: Lens' DeleteKnownHostKeysResponse Int Source #

The response's http status code.

DeleteLoadBalancer

deleteLoadBalancer_loadBalancerName :: Lens' DeleteLoadBalancer Text Source #

The name of the load balancer you want to delete.

deleteLoadBalancerResponse_operations :: Lens' DeleteLoadBalancerResponse (Maybe [Operation]) Source #

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.

deleteLoadBalancerResponse_httpStatus :: Lens' DeleteLoadBalancerResponse Int Source #

The response's http status code.

DeleteLoadBalancerTlsCertificate

deleteLoadBalancerTlsCertificate_force :: Lens' DeleteLoadBalancerTlsCertificate (Maybe Bool) Source #

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.

deleteLoadBalancerTlsCertificate_loadBalancerName :: Lens' DeleteLoadBalancerTlsCertificate Text Source #

The load balancer name.

deleteLoadBalancerTlsCertificate_certificateName :: Lens' DeleteLoadBalancerTlsCertificate Text Source #

The SSL/TLS certificate name.

deleteLoadBalancerTlsCertificateResponse_operations :: Lens' DeleteLoadBalancerTlsCertificateResponse (Maybe [Operation]) Source #

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.

deleteLoadBalancerTlsCertificateResponse_httpStatus :: Lens' DeleteLoadBalancerTlsCertificateResponse Int Source #

The response's http status code.

DeleteRelationalDatabase

deleteRelationalDatabase_finalRelationalDatabaseSnapshotName :: Lens' DeleteRelationalDatabase (Maybe Text) Source #

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.

deleteRelationalDatabase_skipFinalSnapshot :: Lens' DeleteRelationalDatabase (Maybe Bool) Source #

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

deleteRelationalDatabase_relationalDatabaseName :: Lens' DeleteRelationalDatabase Text Source #

The name of the database that you are deleting.

deleteRelationalDatabaseResponse_operations :: Lens' DeleteRelationalDatabaseResponse (Maybe [Operation]) Source #

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.

deleteRelationalDatabaseResponse_httpStatus :: Lens' DeleteRelationalDatabaseResponse Int Source #

The response's http status code.

DeleteRelationalDatabaseSnapshot

deleteRelationalDatabaseSnapshot_relationalDatabaseSnapshotName :: Lens' DeleteRelationalDatabaseSnapshot Text Source #

The name of the database snapshot that you are deleting.

deleteRelationalDatabaseSnapshotResponse_operations :: Lens' DeleteRelationalDatabaseSnapshotResponse (Maybe [Operation]) Source #

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.

deleteRelationalDatabaseSnapshotResponse_httpStatus :: Lens' DeleteRelationalDatabaseSnapshotResponse Int Source #

The response's http status code.

DetachCertificateFromDistribution

detachCertificateFromDistribution_distributionName :: Lens' DetachCertificateFromDistribution Text Source #

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.

detachCertificateFromDistributionResponse_operation :: Lens' DetachCertificateFromDistributionResponse (Maybe Operation) Source #

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.

detachCertificateFromDistributionResponse_httpStatus :: Lens' DetachCertificateFromDistributionResponse Int Source #

The response's http status code.

DetachDisk

detachDisk_diskName :: Lens' DetachDisk Text Source #

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

detachDiskResponse_operations :: Lens' DetachDiskResponse (Maybe [Operation]) Source #

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.

detachDiskResponse_httpStatus :: Lens' DetachDiskResponse Int Source #

The response's http status code.

DetachInstancesFromLoadBalancer

detachInstancesFromLoadBalancer_loadBalancerName :: Lens' DetachInstancesFromLoadBalancer Text Source #

The name of the Lightsail load balancer.

detachInstancesFromLoadBalancer_instanceNames :: Lens' DetachInstancesFromLoadBalancer [Text] Source #

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

detachInstancesFromLoadBalancerResponse_operations :: Lens' DetachInstancesFromLoadBalancerResponse (Maybe [Operation]) Source #

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.

detachInstancesFromLoadBalancerResponse_httpStatus :: Lens' DetachInstancesFromLoadBalancerResponse Int Source #

The response's http status code.

DetachStaticIp

detachStaticIp_staticIpName :: Lens' DetachStaticIp Text Source #

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

detachStaticIpResponse_operations :: Lens' DetachStaticIpResponse (Maybe [Operation]) Source #

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.

detachStaticIpResponse_httpStatus :: Lens' DetachStaticIpResponse Int Source #

The response's http status code.

DisableAddOn

disableAddOn_addOnType :: Lens' DisableAddOn AddOnType Source #

The add-on type to disable.

disableAddOn_resourceName :: Lens' DisableAddOn Text Source #

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

disableAddOnResponse_operations :: Lens' DisableAddOnResponse (Maybe [Operation]) Source #

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.

disableAddOnResponse_httpStatus :: Lens' DisableAddOnResponse Int Source #

The response's http status code.

DownloadDefaultKeyPair

downloadDefaultKeyPairResponse_createdAt :: Lens' DownloadDefaultKeyPairResponse (Maybe UTCTime) Source #

The timestamp when the default key pair was created.

downloadDefaultKeyPairResponse_privateKeyBase64 :: Lens' DownloadDefaultKeyPairResponse (Maybe Text) Source #

A base64-encoded RSA private key.

downloadDefaultKeyPairResponse_publicKeyBase64 :: Lens' DownloadDefaultKeyPairResponse (Maybe Text) Source #

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

downloadDefaultKeyPairResponse_httpStatus :: Lens' DownloadDefaultKeyPairResponse Int Source #

The response's http status code.

EnableAddOn

enableAddOn_resourceName :: Lens' EnableAddOn Text Source #

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

enableAddOn_addOnRequest :: Lens' EnableAddOn AddOnRequest Source #

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

enableAddOnResponse_operations :: Lens' EnableAddOnResponse (Maybe [Operation]) Source #

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.

enableAddOnResponse_httpStatus :: Lens' EnableAddOnResponse Int Source #

The response's http status code.

ExportSnapshot

exportSnapshot_sourceSnapshotName :: Lens' ExportSnapshot Text Source #

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

exportSnapshotResponse_operations :: Lens' ExportSnapshotResponse (Maybe [Operation]) Source #

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.

exportSnapshotResponse_httpStatus :: Lens' ExportSnapshotResponse Int Source #

The response's http status code.

GetActiveNames

getActiveNames_pageToken :: Lens' GetActiveNames (Maybe Text) Source #

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.

getActiveNamesResponse_activeNames :: Lens' GetActiveNamesResponse (Maybe [Text]) Source #

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

getActiveNamesResponse_nextPageToken :: Lens' GetActiveNamesResponse (Maybe Text) Source #

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.

getActiveNamesResponse_httpStatus :: Lens' GetActiveNamesResponse Int Source #

The response's http status code.

GetAlarms

getAlarms_alarmName :: Lens' GetAlarms (Maybe Text) Source #

The name of the alarm.

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

getAlarms_monitoredResourceName :: Lens' GetAlarms (Maybe Text) Source #

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.

getAlarms_pageToken :: Lens' GetAlarms (Maybe Text) Source #

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.

getAlarmsResponse_alarms :: Lens' GetAlarmsResponse (Maybe [Alarm]) Source #

An array of objects that describe the alarms.

getAlarmsResponse_nextPageToken :: Lens' GetAlarmsResponse (Maybe Text) Source #

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.

getAlarmsResponse_httpStatus :: Lens' GetAlarmsResponse Int Source #

The response's http status code.

GetAutoSnapshots

getAutoSnapshots_resourceName :: Lens' GetAutoSnapshots Text Source #

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

getAutoSnapshotsResponse_autoSnapshots :: Lens' GetAutoSnapshotsResponse (Maybe [AutoSnapshotDetails]) Source #

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

getAutoSnapshotsResponse_resourceName :: Lens' GetAutoSnapshotsResponse (Maybe Text) Source #

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

getAutoSnapshotsResponse_resourceType :: Lens' GetAutoSnapshotsResponse (Maybe ResourceType) Source #

The resource type (e.g., Instance or Disk).

getAutoSnapshotsResponse_httpStatus :: Lens' GetAutoSnapshotsResponse Int Source #

The response's http status code.

GetBlueprints

getBlueprints_includeInactive :: Lens' GetBlueprints (Maybe Bool) Source #

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

getBlueprints_pageToken :: Lens' GetBlueprints (Maybe Text) Source #

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.

getBlueprintsResponse_blueprints :: Lens' GetBlueprintsResponse (Maybe [Blueprint]) Source #

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

getBlueprintsResponse_nextPageToken :: Lens' GetBlueprintsResponse (Maybe Text) Source #

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.

getBlueprintsResponse_httpStatus :: Lens' GetBlueprintsResponse Int Source #

The response's http status code.

GetBucketAccessKeys

getBucketAccessKeys_bucketName :: Lens' GetBucketAccessKeys Text Source #

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

getBucketAccessKeysResponse_accessKeys :: Lens' GetBucketAccessKeysResponse (Maybe [AccessKey]) Source #

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

getBucketAccessKeysResponse_httpStatus :: Lens' GetBucketAccessKeysResponse Int Source #

The response's http status code.

GetBucketBundles

getBucketBundles_includeInactive :: Lens' GetBucketBundles (Maybe Bool) Source #

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

getBucketBundlesResponse_bundles :: Lens' GetBucketBundlesResponse (Maybe [BucketBundle]) Source #

An object that describes bucket bundles.

getBucketBundlesResponse_httpStatus :: Lens' GetBucketBundlesResponse Int Source #

The response's http status code.

GetBucketMetricData

getBucketMetricData_bucketName :: Lens' GetBucketMetricData Text Source #

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

getBucketMetricData_metricName :: Lens' GetBucketMetricData BucketMetricName Source #

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.

getBucketMetricData_startTime :: Lens' GetBucketMetricData UTCTime Source #

The timestamp indicating the earliest data to be returned.

getBucketMetricData_endTime :: Lens' GetBucketMetricData UTCTime Source #

The timestamp indicating the latest data to be returned.

getBucketMetricData_period :: Lens' GetBucketMetricData Natural Source #

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.

getBucketMetricData_statistics :: Lens' GetBucketMetricData [MetricStatistic] Source #

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.

getBucketMetricData_unit :: Lens' GetBucketMetricData MetricUnit Source #

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.

getBucketMetricDataResponse_metricData :: Lens' GetBucketMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getBucketMetricDataResponse_metricName :: Lens' GetBucketMetricDataResponse (Maybe BucketMetricName) Source #

The name of the metric returned.

getBucketMetricDataResponse_httpStatus :: Lens' GetBucketMetricDataResponse Int Source #

The response's http status code.

GetBuckets

getBuckets_bucketName :: Lens' GetBuckets (Maybe Text) Source #

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.

getBuckets_includeConnectedResources :: Lens' GetBuckets (Maybe Bool) Source #

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

getBuckets_pageToken :: Lens' GetBuckets (Maybe Text) Source #

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.

getBucketsResponse_accountLevelBpaSync :: Lens' GetBucketsResponse (Maybe AccountLevelBpaSync) Source #

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.

getBucketsResponse_buckets :: Lens' GetBucketsResponse (Maybe [Bucket]) Source #

An array of objects that describe buckets.

getBucketsResponse_nextPageToken :: Lens' GetBucketsResponse (Maybe Text) Source #

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.

getBucketsResponse_httpStatus :: Lens' GetBucketsResponse Int Source #

The response's http status code.

GetBundles

getBundles_includeInactive :: Lens' GetBundles (Maybe Bool) Source #

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

getBundles_pageToken :: Lens' GetBundles (Maybe Text) Source #

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.

getBundlesResponse_bundles :: Lens' GetBundlesResponse (Maybe [Bundle]) Source #

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

getBundlesResponse_nextPageToken :: Lens' GetBundlesResponse (Maybe Text) Source #

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.

getBundlesResponse_httpStatus :: Lens' GetBundlesResponse Int Source #

The response's http status code.

GetCertificates

getCertificates_certificateName :: Lens' GetCertificates (Maybe Text) Source #

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.

getCertificates_certificateStatuses :: Lens' GetCertificates (Maybe [CertificateStatus]) Source #

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.

getCertificates_includeCertificateDetails :: Lens' GetCertificates (Maybe Bool) Source #

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.

getCertificatesResponse_certificates :: Lens' GetCertificatesResponse (Maybe [CertificateSummary]) Source #

An object that describes certificates.

getCertificatesResponse_httpStatus :: Lens' GetCertificatesResponse Int Source #

The response's http status code.

GetCloudFormationStackRecords

getCloudFormationStackRecords_pageToken :: Lens' GetCloudFormationStackRecords (Maybe Text) Source #

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.

getCloudFormationStackRecordsResponse_cloudFormationStackRecords :: Lens' GetCloudFormationStackRecordsResponse (Maybe [CloudFormationStackRecord]) Source #

A list of objects describing the CloudFormation stack records.

getCloudFormationStackRecordsResponse_nextPageToken :: Lens' GetCloudFormationStackRecordsResponse (Maybe Text) Source #

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.

getCloudFormationStackRecordsResponse_httpStatus :: Lens' GetCloudFormationStackRecordsResponse Int Source #

The response's http status code.

GetContactMethods

getContactMethods_protocols :: Lens' GetContactMethods (Maybe [ContactProtocol]) Source #

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.

getContactMethodsResponse_contactMethods :: Lens' GetContactMethodsResponse (Maybe [ContactMethod]) Source #

An array of objects that describe the contact methods.

getContactMethodsResponse_httpStatus :: Lens' GetContactMethodsResponse Int Source #

The response's http status code.

GetContainerAPIMetadata

getContainerAPIMetadataResponse_metadata :: Lens' GetContainerAPIMetadataResponse (Maybe [HashMap Text Text]) Source #

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

getContainerAPIMetadataResponse_httpStatus :: Lens' GetContainerAPIMetadataResponse Int Source #

The response's http status code.

GetContainerImages

getContainerImages_serviceName :: Lens' GetContainerImages Text Source #

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

getContainerImagesResponse_containerImages :: Lens' GetContainerImagesResponse (Maybe [ContainerImage]) Source #

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

getContainerImagesResponse_httpStatus :: Lens' GetContainerImagesResponse Int Source #

The response's http status code.

GetContainerLog

getContainerLog_endTime :: Lens' GetContainerLog (Maybe UTCTime) Source #

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.

getContainerLog_filterPattern :: Lens' GetContainerLog (Maybe Text) Source #

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".

getContainerLog_pageToken :: Lens' GetContainerLog (Maybe Text) Source #

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.

getContainerLog_startTime :: Lens' GetContainerLog (Maybe UTCTime) Source #

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.

getContainerLog_serviceName :: Lens' GetContainerLog Text Source #

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

getContainerLog_containerName :: Lens' GetContainerLog Text Source #

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

getContainerLogResponse_logEvents :: Lens' GetContainerLogResponse (Maybe [ContainerServiceLogEvent]) Source #

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

getContainerLogResponse_nextPageToken :: Lens' GetContainerLogResponse (Maybe Text) Source #

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.

getContainerLogResponse_httpStatus :: Lens' GetContainerLogResponse Int Source #

The response's http status code.

GetContainerServiceDeployments

getContainerServiceDeployments_serviceName :: Lens' GetContainerServiceDeployments Text Source #

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

getContainerServiceDeploymentsResponse_deployments :: Lens' GetContainerServiceDeploymentsResponse (Maybe [ContainerServiceDeployment]) Source #

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

getContainerServiceDeploymentsResponse_httpStatus :: Lens' GetContainerServiceDeploymentsResponse Int Source #

The response's http status code.

GetContainerServiceMetricData

getContainerServiceMetricData_serviceName :: Lens' GetContainerServiceMetricData Text Source #

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

getContainerServiceMetricData_metricName :: Lens' GetContainerServiceMetricData ContainerServiceMetricName Source #

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.

getContainerServiceMetricData_startTime :: Lens' GetContainerServiceMetricData UTCTime Source #

The start time of the time period.

getContainerServiceMetricData_endTime :: Lens' GetContainerServiceMetricData UTCTime Source #

The end time of the time period.

getContainerServiceMetricData_period :: Lens' GetContainerServiceMetricData Natural Source #

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

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

getContainerServiceMetricData_statistics :: Lens' GetContainerServiceMetricData [MetricStatistic] Source #

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.

getContainerServiceMetricDataResponse_metricData :: Lens' GetContainerServiceMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getContainerServiceMetricDataResponse_metricName :: Lens' GetContainerServiceMetricDataResponse (Maybe ContainerServiceMetricName) Source #

The name of the metric returned.

getContainerServiceMetricDataResponse_httpStatus :: Lens' GetContainerServiceMetricDataResponse Int Source #

The response's http status code.

GetContainerServicePowers

getContainerServicePowersResponse_powers :: Lens' GetContainerServicePowersResponse (Maybe [ContainerServicePower]) Source #

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

getContainerServicePowersResponse_httpStatus :: Lens' GetContainerServicePowersResponse Int Source #

The response's http status code.

GetContainerServices

getContainerServices_serviceName :: Lens' GetContainerServices (Maybe Text) Source #

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.

getContainerServicesResponse_containerServices :: Lens' GetContainerServicesResponse (Maybe [ContainerService]) Source #

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

getContainerServicesResponse_httpStatus :: Lens' GetContainerServicesResponse Int Source #

The response's http status code.

GetDisk

getDisk_diskName :: Lens' GetDisk Text Source #

The name of the disk (e.g., my-disk).

getDiskResponse_disk :: Lens' GetDiskResponse (Maybe Disk) Source #

An object containing information about the disk.

getDiskResponse_httpStatus :: Lens' GetDiskResponse Int Source #

The response's http status code.

GetDiskSnapshot

getDiskSnapshot_diskSnapshotName :: Lens' GetDiskSnapshot Text Source #

The name of the disk snapshot (e.g., my-disk-snapshot).

getDiskSnapshotResponse_diskSnapshot :: Lens' GetDiskSnapshotResponse (Maybe DiskSnapshot) Source #

An object containing information about the disk snapshot.

getDiskSnapshotResponse_httpStatus :: Lens' GetDiskSnapshotResponse Int Source #

The response's http status code.

GetDiskSnapshots

getDiskSnapshots_pageToken :: Lens' GetDiskSnapshots (Maybe Text) Source #

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.

getDiskSnapshotsResponse_diskSnapshots :: Lens' GetDiskSnapshotsResponse (Maybe [DiskSnapshot]) Source #

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

getDiskSnapshotsResponse_nextPageToken :: Lens' GetDiskSnapshotsResponse (Maybe Text) Source #

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.

getDiskSnapshotsResponse_httpStatus :: Lens' GetDiskSnapshotsResponse Int Source #

The response's http status code.

GetDisks

getDisks_pageToken :: Lens' GetDisks (Maybe Text) Source #

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.

getDisksResponse_disks :: Lens' GetDisksResponse (Maybe [Disk]) Source #

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

getDisksResponse_nextPageToken :: Lens' GetDisksResponse (Maybe Text) Source #

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.

getDisksResponse_httpStatus :: Lens' GetDisksResponse Int Source #

The response's http status code.

GetDistributionBundles

getDistributionBundlesResponse_bundles :: Lens' GetDistributionBundlesResponse (Maybe [DistributionBundle]) Source #

An object that describes a distribution bundle.

getDistributionBundlesResponse_httpStatus :: Lens' GetDistributionBundlesResponse Int Source #

The response's http status code.

GetDistributionLatestCacheReset

getDistributionLatestCacheReset_distributionName :: Lens' GetDistributionLatestCacheReset (Maybe Text) Source #

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.

getDistributionLatestCacheResetResponse_createTime :: Lens' GetDistributionLatestCacheResetResponse (Maybe UTCTime) Source #

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

getDistributionLatestCacheResetResponse_status :: Lens' GetDistributionLatestCacheResetResponse (Maybe Text) Source #

The status of the last cache reset.

getDistributionLatestCacheResetResponse_httpStatus :: Lens' GetDistributionLatestCacheResetResponse Int Source #

The response's http status code.

GetDistributionMetricData

getDistributionMetricData_distributionName :: Lens' GetDistributionMetricData Text Source #

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.

getDistributionMetricData_metricName :: Lens' GetDistributionMetricData DistributionMetricName Source #

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.

getDistributionMetricData_startTime :: Lens' GetDistributionMetricData UTCTime Source #

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.

getDistributionMetricData_endTime :: Lens' GetDistributionMetricData UTCTime Source #

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.

getDistributionMetricData_period :: Lens' GetDistributionMetricData Natural Source #

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

getDistributionMetricData_unit :: Lens' GetDistributionMetricData MetricUnit Source #

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.

getDistributionMetricData_statistics :: Lens' GetDistributionMetricData [MetricStatistic] Source #

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.

getDistributionMetricDataResponse_metricData :: Lens' GetDistributionMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getDistributionMetricDataResponse_metricName :: Lens' GetDistributionMetricDataResponse (Maybe DistributionMetricName) Source #

The name of the metric returned.

getDistributionMetricDataResponse_httpStatus :: Lens' GetDistributionMetricDataResponse Int Source #

The response's http status code.

GetDistributions

getDistributions_distributionName :: Lens' GetDistributions (Maybe Text) Source #

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.

getDistributions_pageToken :: Lens' GetDistributions (Maybe Text) Source #

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.

getDistributionsResponse_distributions :: Lens' GetDistributionsResponse (Maybe [LightsailDistribution]) Source #

An array of objects that describe your distributions.

getDistributionsResponse_nextPageToken :: Lens' GetDistributionsResponse (Maybe Text) Source #

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.

getDistributionsResponse_httpStatus :: Lens' GetDistributionsResponse Int Source #

The response's http status code.

GetDomain

getDomain_domainName :: Lens' GetDomain Text Source #

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

getDomainResponse_domain :: Lens' GetDomainResponse (Maybe Domain) Source #

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

getDomainResponse_httpStatus :: Lens' GetDomainResponse Int Source #

The response's http status code.

GetDomains

getDomains_pageToken :: Lens' GetDomains (Maybe Text) Source #

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.

getDomainsResponse_domains :: Lens' GetDomainsResponse (Maybe [Domain]) Source #

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

getDomainsResponse_nextPageToken :: Lens' GetDomainsResponse (Maybe Text) Source #

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.

getDomainsResponse_httpStatus :: Lens' GetDomainsResponse Int Source #

The response's http status code.

GetExportSnapshotRecords

getExportSnapshotRecords_pageToken :: Lens' GetExportSnapshotRecords (Maybe Text) Source #

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.

getExportSnapshotRecordsResponse_exportSnapshotRecords :: Lens' GetExportSnapshotRecordsResponse (Maybe [ExportSnapshotRecord]) Source #

A list of objects describing the export snapshot records.

getExportSnapshotRecordsResponse_nextPageToken :: Lens' GetExportSnapshotRecordsResponse (Maybe Text) Source #

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.

getExportSnapshotRecordsResponse_httpStatus :: Lens' GetExportSnapshotRecordsResponse Int Source #

The response's http status code.

GetInstance

getInstance_instanceName :: Lens' GetInstance Text Source #

The name of the instance.

getInstanceResponse_instance :: Lens' GetInstanceResponse (Maybe Instance) Source #

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

getInstanceResponse_httpStatus :: Lens' GetInstanceResponse Int Source #

The response's http status code.

GetInstanceAccessDetails

getInstanceAccessDetails_protocol :: Lens' GetInstanceAccessDetails (Maybe InstanceAccessProtocol) Source #

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

getInstanceAccessDetails_instanceName :: Lens' GetInstanceAccessDetails Text Source #

The name of the instance to access.

getInstanceAccessDetailsResponse_accessDetails :: Lens' GetInstanceAccessDetailsResponse (Maybe InstanceAccessDetails) Source #

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

getInstanceAccessDetailsResponse_httpStatus :: Lens' GetInstanceAccessDetailsResponse Int Source #

The response's http status code.

GetInstanceMetricData

getInstanceMetricData_instanceName :: Lens' GetInstanceMetricData Text Source #

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

getInstanceMetricData_metricName :: Lens' GetInstanceMetricData InstanceMetricName Source #

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.

getInstanceMetricData_period :: Lens' GetInstanceMetricData Natural Source #

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.

getInstanceMetricData_startTime :: Lens' GetInstanceMetricData UTCTime Source #

The start time of the time period.

getInstanceMetricData_endTime :: Lens' GetInstanceMetricData UTCTime Source #

The end time of the time period.

getInstanceMetricData_unit :: Lens' GetInstanceMetricData MetricUnit Source #

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.

getInstanceMetricData_statistics :: Lens' GetInstanceMetricData [MetricStatistic] Source #

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.

getInstanceMetricDataResponse_metricData :: Lens' GetInstanceMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getInstanceMetricDataResponse_metricName :: Lens' GetInstanceMetricDataResponse (Maybe InstanceMetricName) Source #

The name of the metric returned.

getInstanceMetricDataResponse_httpStatus :: Lens' GetInstanceMetricDataResponse Int Source #

The response's http status code.

GetInstancePortStates

getInstancePortStates_instanceName :: Lens' GetInstancePortStates Text Source #

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

getInstancePortStatesResponse_portStates :: Lens' GetInstancePortStatesResponse (Maybe [InstancePortState]) Source #

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

getInstancePortStatesResponse_httpStatus :: Lens' GetInstancePortStatesResponse Int Source #

The response's http status code.

GetInstanceSnapshot

getInstanceSnapshot_instanceSnapshotName :: Lens' GetInstanceSnapshot Text Source #

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

getInstanceSnapshotResponse_instanceSnapshot :: Lens' GetInstanceSnapshotResponse (Maybe InstanceSnapshot) Source #

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

getInstanceSnapshotResponse_httpStatus :: Lens' GetInstanceSnapshotResponse Int Source #

The response's http status code.

GetInstanceSnapshots

getInstanceSnapshots_pageToken :: Lens' GetInstanceSnapshots (Maybe Text) Source #

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.

getInstanceSnapshotsResponse_instanceSnapshots :: Lens' GetInstanceSnapshotsResponse (Maybe [InstanceSnapshot]) Source #

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

getInstanceSnapshotsResponse_nextPageToken :: Lens' GetInstanceSnapshotsResponse (Maybe Text) Source #

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.

getInstanceSnapshotsResponse_httpStatus :: Lens' GetInstanceSnapshotsResponse Int Source #

The response's http status code.

GetInstanceState

getInstanceState_instanceName :: Lens' GetInstanceState Text Source #

The name of the instance to get state information about.

getInstanceStateResponse_state :: Lens' GetInstanceStateResponse (Maybe InstanceState) Source #

The state of the instance.

getInstanceStateResponse_httpStatus :: Lens' GetInstanceStateResponse Int Source #

The response's http status code.

GetInstances

getInstances_pageToken :: Lens' GetInstances (Maybe Text) Source #

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.

getInstancesResponse_instances :: Lens' GetInstancesResponse (Maybe [Instance]) Source #

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

getInstancesResponse_nextPageToken :: Lens' GetInstancesResponse (Maybe Text) Source #

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.

getInstancesResponse_httpStatus :: Lens' GetInstancesResponse Int Source #

The response's http status code.

GetKeyPair

getKeyPair_keyPairName :: Lens' GetKeyPair Text Source #

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

getKeyPairResponse_keyPair :: Lens' GetKeyPairResponse (Maybe KeyPair) Source #

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

getKeyPairResponse_httpStatus :: Lens' GetKeyPairResponse Int Source #

The response's http status code.

GetKeyPairs

getKeyPairs_includeDefaultKeyPair :: Lens' GetKeyPairs (Maybe Bool) Source #

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

getKeyPairs_pageToken :: Lens' GetKeyPairs (Maybe Text) Source #

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.

getKeyPairsResponse_keyPairs :: Lens' GetKeyPairsResponse (Maybe [KeyPair]) Source #

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

getKeyPairsResponse_nextPageToken :: Lens' GetKeyPairsResponse (Maybe Text) Source #

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.

getKeyPairsResponse_httpStatus :: Lens' GetKeyPairsResponse Int Source #

The response's http status code.

GetLoadBalancer

getLoadBalancer_loadBalancerName :: Lens' GetLoadBalancer Text Source #

The name of the load balancer.

getLoadBalancerResponse_loadBalancer :: Lens' GetLoadBalancerResponse (Maybe LoadBalancer) Source #

An object containing information about your load balancer.

getLoadBalancerResponse_httpStatus :: Lens' GetLoadBalancerResponse Int Source #

The response's http status code.

GetLoadBalancerMetricData

getLoadBalancerMetricData_loadBalancerName :: Lens' GetLoadBalancerMetricData Text Source #

The name of the load balancer.

getLoadBalancerMetricData_metricName :: Lens' GetLoadBalancerMetricData LoadBalancerMetricName Source #

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.

getLoadBalancerMetricData_period :: Lens' GetLoadBalancerMetricData Natural Source #

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

getLoadBalancerMetricData_startTime :: Lens' GetLoadBalancerMetricData UTCTime Source #

The start time of the period.

getLoadBalancerMetricData_endTime :: Lens' GetLoadBalancerMetricData UTCTime Source #

The end time of the period.

getLoadBalancerMetricData_unit :: Lens' GetLoadBalancerMetricData MetricUnit Source #

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.

getLoadBalancerMetricData_statistics :: Lens' GetLoadBalancerMetricData [MetricStatistic] Source #

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.

getLoadBalancerMetricDataResponse_metricData :: Lens' GetLoadBalancerMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getLoadBalancerMetricDataResponse_metricName :: Lens' GetLoadBalancerMetricDataResponse (Maybe LoadBalancerMetricName) Source #

The name of the metric returned.

getLoadBalancerMetricDataResponse_httpStatus :: Lens' GetLoadBalancerMetricDataResponse Int Source #

The response's http status code.

GetLoadBalancerTlsCertificates

getLoadBalancerTlsCertificates_loadBalancerName :: Lens' GetLoadBalancerTlsCertificates Text Source #

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

getLoadBalancerTlsCertificatesResponse_tlsCertificates :: Lens' GetLoadBalancerTlsCertificatesResponse (Maybe [LoadBalancerTlsCertificate]) Source #

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

getLoadBalancerTlsCertificatesResponse_httpStatus :: Lens' GetLoadBalancerTlsCertificatesResponse Int Source #

The response's http status code.

GetLoadBalancerTlsPolicies

getLoadBalancerTlsPolicies_pageToken :: Lens' GetLoadBalancerTlsPolicies (Maybe Text) Source #

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.

getLoadBalancerTlsPoliciesResponse_nextPageToken :: Lens' GetLoadBalancerTlsPoliciesResponse (Maybe Text) Source #

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.

getLoadBalancerTlsPoliciesResponse_tlsPolicies :: Lens' GetLoadBalancerTlsPoliciesResponse (Maybe [LoadBalancerTlsPolicy]) Source #

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

getLoadBalancerTlsPoliciesResponse_httpStatus :: Lens' GetLoadBalancerTlsPoliciesResponse Int Source #

The response's http status code.

GetLoadBalancers

getLoadBalancers_pageToken :: Lens' GetLoadBalancers (Maybe Text) Source #

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.

getLoadBalancersResponse_loadBalancers :: Lens' GetLoadBalancersResponse (Maybe [LoadBalancer]) Source #

An array of LoadBalancer objects describing your load balancers.

getLoadBalancersResponse_nextPageToken :: Lens' GetLoadBalancersResponse (Maybe Text) Source #

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.

getLoadBalancersResponse_httpStatus :: Lens' GetLoadBalancersResponse Int Source #

The response's http status code.

GetOperation

getOperation_operationId :: Lens' GetOperation Text Source #

A GUID used to identify the operation.

getOperationResponse_operation :: Lens' GetOperationResponse (Maybe Operation) Source #

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.

getOperationResponse_httpStatus :: Lens' GetOperationResponse Int Source #

The response's http status code.

GetOperations

getOperations_pageToken :: Lens' GetOperations (Maybe Text) Source #

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.

getOperationsResponse_nextPageToken :: Lens' GetOperationsResponse (Maybe Text) Source #

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.

getOperationsResponse_operations :: Lens' GetOperationsResponse (Maybe [Operation]) Source #

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.

getOperationsResponse_httpStatus :: Lens' GetOperationsResponse Int Source #

The response's http status code.

GetOperationsForResource

getOperationsForResource_pageToken :: Lens' GetOperationsForResource (Maybe Text) Source #

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.

getOperationsForResource_resourceName :: Lens' GetOperationsForResource Text Source #

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

getOperationsForResourceResponse_nextPageCount :: Lens' GetOperationsForResourceResponse (Maybe Text) Source #

(Deprecated) 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 deprecated, and the API returns the next page token parameter instead.

getOperationsForResourceResponse_nextPageToken :: Lens' GetOperationsForResourceResponse (Maybe Text) Source #

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.

getOperationsForResourceResponse_operations :: Lens' GetOperationsForResourceResponse (Maybe [Operation]) Source #

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.

getOperationsForResourceResponse_httpStatus :: Lens' GetOperationsForResourceResponse Int Source #

The response's http status code.

GetRegions

getRegions_includeAvailabilityZones :: Lens' GetRegions (Maybe Bool) Source #

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

getRegions_includeRelationalDatabaseAvailabilityZones :: Lens' GetRegions (Maybe Bool) Source #

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

getRegionsResponse_regions :: Lens' GetRegionsResponse (Maybe [RegionInfo]) Source #

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

getRegionsResponse_httpStatus :: Lens' GetRegionsResponse Int Source #

The response's http status code.

GetRelationalDatabase

getRelationalDatabase_relationalDatabaseName :: Lens' GetRelationalDatabase Text Source #

The name of the database that you are looking up.

getRelationalDatabaseResponse_relationalDatabase :: Lens' GetRelationalDatabaseResponse (Maybe RelationalDatabase) Source #

An object describing the specified database.

getRelationalDatabaseResponse_httpStatus :: Lens' GetRelationalDatabaseResponse Int Source #

The response's http status code.

GetRelationalDatabaseBlueprints

getRelationalDatabaseBlueprints_pageToken :: Lens' GetRelationalDatabaseBlueprints (Maybe Text) Source #

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.

getRelationalDatabaseBlueprintsResponse_blueprints :: Lens' GetRelationalDatabaseBlueprintsResponse (Maybe [RelationalDatabaseBlueprint]) Source #

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

getRelationalDatabaseBlueprintsResponse_nextPageToken :: Lens' GetRelationalDatabaseBlueprintsResponse (Maybe Text) Source #

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.

getRelationalDatabaseBlueprintsResponse_httpStatus :: Lens' GetRelationalDatabaseBlueprintsResponse Int Source #

The response's http status code.

GetRelationalDatabaseBundles

getRelationalDatabaseBundles_includeInactive :: Lens' GetRelationalDatabaseBundles (Maybe Bool) Source #

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

getRelationalDatabaseBundles_pageToken :: Lens' GetRelationalDatabaseBundles (Maybe Text) Source #

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.

getRelationalDatabaseBundlesResponse_bundles :: Lens' GetRelationalDatabaseBundlesResponse (Maybe [RelationalDatabaseBundle]) Source #

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

getRelationalDatabaseBundlesResponse_nextPageToken :: Lens' GetRelationalDatabaseBundlesResponse (Maybe Text) Source #

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.

getRelationalDatabaseBundlesResponse_httpStatus :: Lens' GetRelationalDatabaseBundlesResponse Int Source #

The response's http status code.

GetRelationalDatabaseEvents

getRelationalDatabaseEvents_durationInMinutes :: Lens' GetRelationalDatabaseEvents (Maybe Int) Source #

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).

getRelationalDatabaseEvents_pageToken :: Lens' GetRelationalDatabaseEvents (Maybe Text) Source #

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.

getRelationalDatabaseEvents_relationalDatabaseName :: Lens' GetRelationalDatabaseEvents Text Source #

The name of the database from which to get events.

getRelationalDatabaseEventsResponse_nextPageToken :: Lens' GetRelationalDatabaseEventsResponse (Maybe Text) Source #

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.

getRelationalDatabaseEventsResponse_relationalDatabaseEvents :: Lens' GetRelationalDatabaseEventsResponse (Maybe [RelationalDatabaseEvent]) Source #

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

getRelationalDatabaseEventsResponse_httpStatus :: Lens' GetRelationalDatabaseEventsResponse Int Source #

The response's http status code.

GetRelationalDatabaseLogEvents

getRelationalDatabaseLogEvents_endTime :: Lens' GetRelationalDatabaseLogEvents (Maybe UTCTime) Source #

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.

getRelationalDatabaseLogEvents_pageToken :: Lens' GetRelationalDatabaseLogEvents (Maybe Text) Source #

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.

getRelationalDatabaseLogEvents_startFromHead :: Lens' GetRelationalDatabaseLogEvents (Maybe Bool) Source #

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.

getRelationalDatabaseLogEvents_startTime :: Lens' GetRelationalDatabaseLogEvents (Maybe UTCTime) Source #

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.

getRelationalDatabaseLogEvents_relationalDatabaseName :: Lens' GetRelationalDatabaseLogEvents Text Source #

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

getRelationalDatabaseLogEvents_logStreamName :: Lens' GetRelationalDatabaseLogEvents Text Source #

The name of the log stream.

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

getRelationalDatabaseLogEventsResponse_nextBackwardToken :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe Text) Source #

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

getRelationalDatabaseLogEventsResponse_nextForwardToken :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe Text) Source #

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

getRelationalDatabaseLogEventsResponse_resourceLogEvents :: Lens' GetRelationalDatabaseLogEventsResponse (Maybe [LogEvent]) Source #

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

getRelationalDatabaseLogEventsResponse_httpStatus :: Lens' GetRelationalDatabaseLogEventsResponse Int Source #

The response's http status code.

GetRelationalDatabaseLogStreams

getRelationalDatabaseLogStreams_relationalDatabaseName :: Lens' GetRelationalDatabaseLogStreams Text Source #

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

getRelationalDatabaseLogStreamsResponse_logStreams :: Lens' GetRelationalDatabaseLogStreamsResponse (Maybe [Text]) Source #

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

getRelationalDatabaseLogStreamsResponse_httpStatus :: Lens' GetRelationalDatabaseLogStreamsResponse Int Source #

The response's http status code.

GetRelationalDatabaseMasterUserPassword

getRelationalDatabaseMasterUserPassword_passwordVersion :: Lens' GetRelationalDatabaseMasterUserPassword (Maybe RelationalDatabasePasswordVersion) Source #

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

getRelationalDatabaseMasterUserPassword_relationalDatabaseName :: Lens' GetRelationalDatabaseMasterUserPassword Text Source #

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

getRelationalDatabaseMasterUserPasswordResponse_createdAt :: Lens' GetRelationalDatabaseMasterUserPasswordResponse (Maybe UTCTime) Source #

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

getRelationalDatabaseMasterUserPasswordResponse_masterUserPassword :: Lens' GetRelationalDatabaseMasterUserPasswordResponse (Maybe Text) Source #

The master user password for the password version specified.

getRelationalDatabaseMasterUserPasswordResponse_httpStatus :: Lens' GetRelationalDatabaseMasterUserPasswordResponse Int Source #

The response's http status code.

GetRelationalDatabaseMetricData

getRelationalDatabaseMetricData_relationalDatabaseName :: Lens' GetRelationalDatabaseMetricData Text Source #

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

getRelationalDatabaseMetricData_metricName :: Lens' GetRelationalDatabaseMetricData RelationalDatabaseMetricName Source #

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.

getRelationalDatabaseMetricData_period :: Lens' GetRelationalDatabaseMetricData Natural Source #

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

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

getRelationalDatabaseMetricData_startTime :: Lens' GetRelationalDatabaseMetricData UTCTime Source #

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.

getRelationalDatabaseMetricData_endTime :: Lens' GetRelationalDatabaseMetricData UTCTime Source #

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.

getRelationalDatabaseMetricData_unit :: Lens' GetRelationalDatabaseMetricData MetricUnit Source #

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.

getRelationalDatabaseMetricData_statistics :: Lens' GetRelationalDatabaseMetricData [MetricStatistic] Source #

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.

getRelationalDatabaseMetricDataResponse_metricData :: Lens' GetRelationalDatabaseMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getRelationalDatabaseMetricDataResponse_metricName :: Lens' GetRelationalDatabaseMetricDataResponse (Maybe RelationalDatabaseMetricName) Source #

The name of the metric returned.

getRelationalDatabaseMetricDataResponse_httpStatus :: Lens' GetRelationalDatabaseMetricDataResponse Int Source #

The response's http status code.

GetRelationalDatabaseParameters

getRelationalDatabaseParameters_pageToken :: Lens' GetRelationalDatabaseParameters (Maybe Text) Source #

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.

getRelationalDatabaseParameters_relationalDatabaseName :: Lens' GetRelationalDatabaseParameters Text Source #

The name of your database for which to get parameters.

getRelationalDatabaseParametersResponse_nextPageToken :: Lens' GetRelationalDatabaseParametersResponse (Maybe Text) Source #

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.

getRelationalDatabaseParametersResponse_parameters :: Lens' GetRelationalDatabaseParametersResponse (Maybe [RelationalDatabaseParameter]) Source #

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

getRelationalDatabaseParametersResponse_httpStatus :: Lens' GetRelationalDatabaseParametersResponse Int Source #

The response's http status code.

GetRelationalDatabaseSnapshot

getRelationalDatabaseSnapshot_relationalDatabaseSnapshotName :: Lens' GetRelationalDatabaseSnapshot Text Source #

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

getRelationalDatabaseSnapshotResponse_relationalDatabaseSnapshot :: Lens' GetRelationalDatabaseSnapshotResponse (Maybe RelationalDatabaseSnapshot) Source #

An object describing the specified database snapshot.

getRelationalDatabaseSnapshotResponse_httpStatus :: Lens' GetRelationalDatabaseSnapshotResponse Int Source #

The response's http status code.

GetRelationalDatabaseSnapshots

getRelationalDatabaseSnapshots_pageToken :: Lens' GetRelationalDatabaseSnapshots (Maybe Text) Source #

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.

getRelationalDatabaseSnapshotsResponse_nextPageToken :: Lens' GetRelationalDatabaseSnapshotsResponse (Maybe Text) Source #

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.

getRelationalDatabaseSnapshotsResponse_relationalDatabaseSnapshots :: Lens' GetRelationalDatabaseSnapshotsResponse (Maybe [RelationalDatabaseSnapshot]) Source #

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

getRelationalDatabaseSnapshotsResponse_httpStatus :: Lens' GetRelationalDatabaseSnapshotsResponse Int Source #

The response's http status code.

GetRelationalDatabases

getRelationalDatabases_pageToken :: Lens' GetRelationalDatabases (Maybe Text) Source #

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.

getRelationalDatabasesResponse_nextPageToken :: Lens' GetRelationalDatabasesResponse (Maybe Text) Source #

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.

getRelationalDatabasesResponse_relationalDatabases :: Lens' GetRelationalDatabasesResponse (Maybe [RelationalDatabase]) Source #

An object describing the result of your get relational databases request.

getRelationalDatabasesResponse_httpStatus :: Lens' GetRelationalDatabasesResponse Int Source #

The response's http status code.

GetStaticIp

getStaticIp_staticIpName :: Lens' GetStaticIp Text Source #

The name of the static IP in Lightsail.

getStaticIpResponse_staticIp :: Lens' GetStaticIpResponse (Maybe StaticIp) Source #

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

getStaticIpResponse_httpStatus :: Lens' GetStaticIpResponse Int Source #

The response's http status code.

GetStaticIps

getStaticIps_pageToken :: Lens' GetStaticIps (Maybe Text) Source #

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.

getStaticIpsResponse_nextPageToken :: Lens' GetStaticIpsResponse (Maybe Text) Source #

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.

getStaticIpsResponse_staticIps :: Lens' GetStaticIpsResponse (Maybe [StaticIp]) Source #

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

getStaticIpsResponse_httpStatus :: Lens' GetStaticIpsResponse Int Source #

The response's http status code.

ImportKeyPair

importKeyPair_keyPairName :: Lens' ImportKeyPair Text Source #

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

importKeyPair_publicKeyBase64 :: Lens' ImportKeyPair Text Source #

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

importKeyPairResponse_operation :: Lens' ImportKeyPairResponse (Maybe Operation) Source #

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.

importKeyPairResponse_httpStatus :: Lens' ImportKeyPairResponse Int Source #

The response's http status code.

IsVpcPeered

isVpcPeeredResponse_isPeered :: Lens' IsVpcPeeredResponse (Maybe Bool) Source #

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

isVpcPeeredResponse_httpStatus :: Lens' IsVpcPeeredResponse Int Source #

The response's http status code.

OpenInstancePublicPorts

openInstancePublicPorts_portInfo :: Lens' OpenInstancePublicPorts PortInfo Source #

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

openInstancePublicPorts_instanceName :: Lens' OpenInstancePublicPorts Text Source #

The name of the instance for which to open ports.

openInstancePublicPortsResponse_operation :: Lens' OpenInstancePublicPortsResponse (Maybe Operation) Source #

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.

openInstancePublicPortsResponse_httpStatus :: Lens' OpenInstancePublicPortsResponse Int Source #

The response's http status code.

PeerVpc

peerVpcResponse_operation :: Lens' PeerVpcResponse (Maybe Operation) Source #

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.

peerVpcResponse_httpStatus :: Lens' PeerVpcResponse Int Source #

The response's http status code.

PutAlarm

putAlarm_contactProtocols :: Lens' PutAlarm (Maybe [ContactProtocol]) Source #

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.

putAlarm_datapointsToAlarm :: Lens' PutAlarm (Maybe Int) Source #

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.

putAlarm_notificationEnabled :: Lens' PutAlarm (Maybe Bool) Source #

Indicates whether the alarm is enabled.

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

putAlarm_notificationTriggers :: Lens' PutAlarm (Maybe [AlarmState]) Source #

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.

putAlarm_treatMissingData :: Lens' PutAlarm (Maybe TreatMissingData) Source #

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.

putAlarm_alarmName :: Lens' PutAlarm Text Source #

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

putAlarm_metricName :: Lens' PutAlarm MetricName Source #

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.

putAlarm_monitoredResourceName :: Lens' PutAlarm Text Source #

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.

putAlarm_comparisonOperator :: Lens' PutAlarm ComparisonOperator Source #

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

putAlarm_threshold :: Lens' PutAlarm Double Source #

The value against which the specified statistic is compared.

putAlarm_evaluationPeriods :: Lens' PutAlarm Int Source #

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).

putAlarmResponse_operations :: Lens' PutAlarmResponse (Maybe [Operation]) Source #

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.

putAlarmResponse_httpStatus :: Lens' PutAlarmResponse Int Source #

The response's http status code.

PutInstancePublicPorts

putInstancePublicPorts_portInfos :: Lens' PutInstancePublicPorts [PortInfo] Source #

An array of objects to describe the ports to open for the specified instance.

putInstancePublicPorts_instanceName :: Lens' PutInstancePublicPorts Text Source #

The name of the instance for which to open ports.

putInstancePublicPortsResponse_operation :: Lens' PutInstancePublicPortsResponse (Maybe Operation) Source #

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.

putInstancePublicPortsResponse_httpStatus :: Lens' PutInstancePublicPortsResponse Int Source #

The response's http status code.

RebootInstance

rebootInstance_instanceName :: Lens' RebootInstance Text Source #

The name of the instance to reboot.

rebootInstanceResponse_operations :: Lens' RebootInstanceResponse (Maybe [Operation]) Source #

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.

rebootInstanceResponse_httpStatus :: Lens' RebootInstanceResponse Int Source #

The response's http status code.

RebootRelationalDatabase

rebootRelationalDatabase_relationalDatabaseName :: Lens' RebootRelationalDatabase Text Source #

The name of your database to reboot.

rebootRelationalDatabaseResponse_operations :: Lens' RebootRelationalDatabaseResponse (Maybe [Operation]) Source #

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.

rebootRelationalDatabaseResponse_httpStatus :: Lens' RebootRelationalDatabaseResponse Int Source #

The response's http status code.

RegisterContainerImage

registerContainerImage_serviceName :: Lens' RegisterContainerImage Text Source #

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

registerContainerImage_label :: Lens' RegisterContainerImage Text Source #

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 <imagelabel> portion of the following image name example:

  • :container-service-1.<imagelabel>.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.

registerContainerImage_digest :: Lens' RegisterContainerImage Text Source #

The digest of the container image to be registered.

registerContainerImageResponse_containerImage :: Lens' RegisterContainerImageResponse (Maybe ContainerImage) Source #

An object that describes a container image that is registered to a Lightsail container service

registerContainerImageResponse_httpStatus :: Lens' RegisterContainerImageResponse Int Source #

The response's http status code.

ReleaseStaticIp

releaseStaticIp_staticIpName :: Lens' ReleaseStaticIp Text Source #

The name of the static IP to delete.

releaseStaticIpResponse_operations :: Lens' ReleaseStaticIpResponse (Maybe [Operation]) Source #

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.

releaseStaticIpResponse_httpStatus :: Lens' ReleaseStaticIpResponse Int Source #

The response's http status code.

ResetDistributionCache

resetDistributionCache_distributionName :: Lens' ResetDistributionCache (Maybe Text) Source #

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.

resetDistributionCacheResponse_createTime :: Lens' ResetDistributionCacheResponse (Maybe UTCTime) Source #

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time format.

resetDistributionCacheResponse_operation :: Lens' ResetDistributionCacheResponse (Maybe Operation) Source #

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.

resetDistributionCacheResponse_status :: Lens' ResetDistributionCacheResponse (Maybe Text) Source #

The status of the reset cache request.

resetDistributionCacheResponse_httpStatus :: Lens' ResetDistributionCacheResponse Int Source #

The response's http status code.

SendContactMethodVerification

sendContactMethodVerification_protocol :: Lens' SendContactMethodVerification ContactMethodVerificationProtocol Source #

The protocol to verify, such as Email or SMS (text messaging).

sendContactMethodVerificationResponse_operations :: Lens' SendContactMethodVerificationResponse (Maybe [Operation]) Source #

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.

sendContactMethodVerificationResponse_httpStatus :: Lens' SendContactMethodVerificationResponse Int Source #

The response's http status code.

SetIpAddressType

setIpAddressType_resourceType :: Lens' SetIpAddressType ResourceType Source #

The resource type.

The possible 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.

setIpAddressType_resourceName :: Lens' SetIpAddressType Text Source #

The name of the resource for which to set the IP address type.

setIpAddressType_ipAddressType :: Lens' SetIpAddressType IpAddressType Source #

The IP address type to set for the specified resource.

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

setIpAddressTypeResponse_operations :: Lens' SetIpAddressTypeResponse (Maybe [Operation]) Source #

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.

setIpAddressTypeResponse_httpStatus :: Lens' SetIpAddressTypeResponse Int Source #

The response's http status code.

SetResourceAccessForBucket

setResourceAccessForBucket_resourceName :: Lens' SetResourceAccessForBucket Text Source #

The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state.

setResourceAccessForBucket_bucketName :: Lens' SetResourceAccessForBucket Text Source #

The name of the bucket for which to set access to another Lightsail resource.

setResourceAccessForBucket_access :: Lens' SetResourceAccessForBucket ResourceBucketAccess Source #

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.

setResourceAccessForBucketResponse_operations :: Lens' SetResourceAccessForBucketResponse (Maybe [Operation]) Source #

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.

setResourceAccessForBucketResponse_httpStatus :: Lens' SetResourceAccessForBucketResponse Int Source #

The response's http status code.

StartInstance

startInstance_instanceName :: Lens' StartInstance Text Source #

The name of the instance (a virtual private server) to start.

startInstanceResponse_operations :: Lens' StartInstanceResponse (Maybe [Operation]) Source #

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.

startInstanceResponse_httpStatus :: Lens' StartInstanceResponse Int Source #

The response's http status code.

StartRelationalDatabase

startRelationalDatabase_relationalDatabaseName :: Lens' StartRelationalDatabase Text Source #

The name of your database to start.

startRelationalDatabaseResponse_operations :: Lens' StartRelationalDatabaseResponse (Maybe [Operation]) Source #

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.

startRelationalDatabaseResponse_httpStatus :: Lens' StartRelationalDatabaseResponse Int Source #

The response's http status code.

StopInstance

stopInstance_force :: Lens' StopInstance (Maybe Bool) Source #

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.

stopInstance_instanceName :: Lens' StopInstance Text Source #

The name of the instance (a virtual private server) to stop.

stopInstanceResponse_operations :: Lens' StopInstanceResponse (Maybe [Operation]) Source #

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.

stopInstanceResponse_httpStatus :: Lens' StopInstanceResponse Int Source #

The response's http status code.

StopRelationalDatabase

stopRelationalDatabase_relationalDatabaseSnapshotName :: Lens' StopRelationalDatabase (Maybe Text) Source #

The name of your new database snapshot to be created before stopping your database.

stopRelationalDatabase_relationalDatabaseName :: Lens' StopRelationalDatabase Text Source #

The name of your database to stop.

stopRelationalDatabaseResponse_operations :: Lens' StopRelationalDatabaseResponse (Maybe [Operation]) Source #

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.

stopRelationalDatabaseResponse_httpStatus :: Lens' StopRelationalDatabaseResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

tagResource_resourceName :: Lens' TagResource Text Source #

The name of the resource to which you are adding tags.

tagResource_tags :: Lens' TagResource [Tag] Source #

The tag key and optional value.

tagResourceResponse_operations :: Lens' TagResourceResponse (Maybe [Operation]) Source #

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.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

TestAlarm

testAlarm_alarmName :: Lens' TestAlarm Text Source #

The name of the alarm to test.

testAlarm_state :: Lens' TestAlarm AlarmState Source #

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.

testAlarmResponse_operations :: Lens' TestAlarmResponse (Maybe [Operation]) Source #

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.

testAlarmResponse_httpStatus :: Lens' TestAlarmResponse Int Source #

The response's http status code.

UnpeerVpc

unpeerVpcResponse_operation :: Lens' UnpeerVpcResponse (Maybe Operation) Source #

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.

unpeerVpcResponse_httpStatus :: Lens' UnpeerVpcResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

untagResource_resourceName :: Lens' UntagResource Text Source #

The name of the resource from which you are removing a tag.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag keys to delete from the specified resource.

untagResourceResponse_operations :: Lens' UntagResourceResponse (Maybe [Operation]) Source #

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.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateBucket

updateBucket_accessLogConfig :: Lens' UpdateBucket (Maybe BucketAccessLogConfig) Source #

An object that describes the access log configuration for the bucket.

updateBucket_accessRules :: Lens' UpdateBucket (Maybe AccessRules) Source #

An object that sets the public accessibility of objects in the specified bucket.

updateBucket_readonlyAccessAccounts :: Lens' UpdateBucket (Maybe [Text]) Source #

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.

updateBucket_versioning :: Lens' UpdateBucket (Maybe Text) Source #

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.

updateBucket_bucketName :: Lens' UpdateBucket Text Source #

The name of the bucket to update.

updateBucketResponse_bucket :: Lens' UpdateBucketResponse (Maybe Bucket) Source #

An object that describes the bucket that is updated.

updateBucketResponse_operations :: Lens' UpdateBucketResponse (Maybe [Operation]) Source #

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.

updateBucketResponse_httpStatus :: Lens' UpdateBucketResponse Int Source #

The response's http status code.

UpdateBucketBundle

updateBucketBundle_bucketName :: Lens' UpdateBucketBundle Text Source #

The name of the bucket for which to update the bundle.

updateBucketBundle_bundleId :: Lens' UpdateBucketBundle Text Source #

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.

updateBucketBundleResponse_operations :: Lens' UpdateBucketBundleResponse (Maybe [Operation]) Source #

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.

updateBucketBundleResponse_httpStatus :: Lens' UpdateBucketBundleResponse Int Source #

The response's http status code.

UpdateContainerService

updateContainerService_isDisabled :: Lens' UpdateContainerService (Maybe Bool) Source #

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

updateContainerService_power :: Lens' UpdateContainerService (Maybe ContainerServicePowerName) Source #

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.

updateContainerService_privateRegistryAccess :: Lens' UpdateContainerService (Maybe PrivateRegistryAccessRequest) Source #

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.

updateContainerService_publicDomainNames :: Lens' UpdateContainerService (Maybe (HashMap Text [Text])) Source #

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.

updateContainerService_scale :: Lens' UpdateContainerService (Maybe Natural) Source #

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.

updateContainerService_serviceName :: Lens' UpdateContainerService Text Source #

The name of the container service to update.

updateContainerServiceResponse_containerService :: Lens' UpdateContainerServiceResponse (Maybe ContainerService) Source #

An object that describes a container service.

updateContainerServiceResponse_httpStatus :: Lens' UpdateContainerServiceResponse Int Source #

The response's http status code.

UpdateDistribution

updateDistribution_cacheBehaviorSettings :: Lens' UpdateDistribution (Maybe CacheSettings) Source #

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

The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.

updateDistribution_cacheBehaviors :: Lens' UpdateDistribution (Maybe [CacheBehaviorPerPath]) Source #

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

updateDistribution_defaultCacheBehavior :: Lens' UpdateDistribution (Maybe CacheBehavior) Source #

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

updateDistribution_isEnabled :: Lens' UpdateDistribution (Maybe Bool) Source #

Indicates whether to enable the distribution.

updateDistribution_origin :: Lens' UpdateDistribution (Maybe InputOrigin) Source #

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.

updateDistribution_distributionName :: Lens' UpdateDistribution Text Source #

The name of the distribution to update.

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

updateDistributionResponse_operation :: Lens' UpdateDistributionResponse (Maybe Operation) Source #

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.

updateDistributionResponse_httpStatus :: Lens' UpdateDistributionResponse Int Source #

The response's http status code.

UpdateDistributionBundle

updateDistributionBundle_bundleId :: Lens' UpdateDistributionBundle (Maybe Text) Source #

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.

updateDistributionBundle_distributionName :: Lens' UpdateDistributionBundle (Maybe Text) Source #

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.

updateDistributionBundleResponse_operation :: Lens' UpdateDistributionBundleResponse (Maybe Operation) Source #

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.

updateDistributionBundleResponse_httpStatus :: Lens' UpdateDistributionBundleResponse Int Source #

The response's http status code.

UpdateDomainEntry

updateDomainEntry_domainName :: Lens' UpdateDomainEntry Text Source #

The name of the domain recordset to update.

updateDomainEntry_domainEntry :: Lens' UpdateDomainEntry DomainEntry Source #

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

updateDomainEntryResponse_operations :: Lens' UpdateDomainEntryResponse (Maybe [Operation]) Source #

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.

updateDomainEntryResponse_httpStatus :: Lens' UpdateDomainEntryResponse Int Source #

The response's http status code.

UpdateInstanceMetadataOptions

updateInstanceMetadataOptions_httpEndpoint :: Lens' UpdateInstanceMetadataOptions (Maybe HttpEndpoint) Source #

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.

updateInstanceMetadataOptions_httpProtocolIpv6 :: Lens' UpdateInstanceMetadataOptions (Maybe HttpProtocolIpv6) Source #

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).

updateInstanceMetadataOptions_httpPutResponseHopLimit :: Lens' UpdateInstanceMetadataOptions (Maybe Int) Source #

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.

updateInstanceMetadataOptions_httpTokens :: Lens' UpdateInstanceMetadataOptions (Maybe HttpTokens) Source #

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.

updateInstanceMetadataOptions_instanceName :: Lens' UpdateInstanceMetadataOptions Text Source #

The name of the instance for which to update metadata parameters.

updateInstanceMetadataOptionsResponse_operation :: Lens' UpdateInstanceMetadataOptionsResponse (Maybe Operation) Source #

Undocumented member.

updateInstanceMetadataOptionsResponse_httpStatus :: Lens' UpdateInstanceMetadataOptionsResponse Int Source #

The response's http status code.

UpdateLoadBalancerAttribute

updateLoadBalancerAttribute_loadBalancerName :: Lens' UpdateLoadBalancerAttribute Text Source #

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

updateLoadBalancerAttribute_attributeName :: Lens' UpdateLoadBalancerAttribute LoadBalancerAttributeName Source #

The name of the attribute you want to update.

updateLoadBalancerAttribute_attributeValue :: Lens' UpdateLoadBalancerAttribute Text Source #

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.

updateLoadBalancerAttributeResponse_operations :: Lens' UpdateLoadBalancerAttributeResponse (Maybe [Operation]) Source #

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.

updateLoadBalancerAttributeResponse_httpStatus :: Lens' UpdateLoadBalancerAttributeResponse Int Source #

The response's http status code.

UpdateRelationalDatabase

updateRelationalDatabase_applyImmediately :: Lens' UpdateRelationalDatabase (Maybe Bool) Source #

When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

updateRelationalDatabase_caCertificateIdentifier :: Lens' UpdateRelationalDatabase (Maybe Text) Source #

Indicates the certificate that needs to be associated with the database.

updateRelationalDatabase_disableBackupRetention :: Lens' UpdateRelationalDatabase (Maybe Bool) Source #

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.

updateRelationalDatabase_enableBackupRetention :: Lens' UpdateRelationalDatabase (Maybe Bool) Source #

When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

updateRelationalDatabase_masterUserPassword :: Lens' UpdateRelationalDatabase (Maybe Text) Source #

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.

updateRelationalDatabase_preferredBackupWindow :: Lens' UpdateRelationalDatabase (Maybe Text) Source #

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.

updateRelationalDatabase_preferredMaintenanceWindow :: Lens' UpdateRelationalDatabase (Maybe Text) Source #

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

updateRelationalDatabase_publiclyAccessible :: Lens' UpdateRelationalDatabase (Maybe Bool) Source #

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.

updateRelationalDatabase_rotateMasterUserPassword :: Lens' UpdateRelationalDatabase (Maybe Bool) Source #

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.

updateRelationalDatabase_relationalDatabaseName :: Lens' UpdateRelationalDatabase Text Source #

The name of your Lightsail database resource to update.

updateRelationalDatabaseResponse_operations :: Lens' UpdateRelationalDatabaseResponse (Maybe [Operation]) Source #

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.

updateRelationalDatabaseResponse_httpStatus :: Lens' UpdateRelationalDatabaseResponse Int Source #

The response's http status code.

UpdateRelationalDatabaseParameters

updateRelationalDatabaseParameters_relationalDatabaseName :: Lens' UpdateRelationalDatabaseParameters Text Source #

The name of your database for which to update parameters.

updateRelationalDatabaseParameters_parameters :: Lens' UpdateRelationalDatabaseParameters [RelationalDatabaseParameter] Source #

The database parameters to update.

updateRelationalDatabaseParametersResponse_operations :: Lens' UpdateRelationalDatabaseParametersResponse (Maybe [Operation]) Source #

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.

updateRelationalDatabaseParametersResponse_httpStatus :: Lens' UpdateRelationalDatabaseParametersResponse Int Source #

The response's http status code.

Types

AccessKey

accessKey_accessKeyId :: Lens' AccessKey (Maybe Text) Source #

The ID of the access key.

accessKey_createdAt :: Lens' AccessKey (Maybe UTCTime) Source #

The timestamp when the access key was created.

accessKey_lastUsed :: Lens' AccessKey (Maybe AccessKeyLastUsed) Source #

An object that describes the last time the access key was used.

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.

accessKey_secretAccessKey :: Lens' AccessKey (Maybe Text) Source #

The secret access key used to sign requests.

You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.

accessKey_status :: Lens' AccessKey (Maybe StatusType) Source #

The status of the access key.

A status of Active means that the key is valid, while Inactive means it is not.

AccessKeyLastUsed

accessKeyLastUsed_lastUsedDate :: Lens' AccessKeyLastUsed (Maybe UTCTime) Source #

The date and time when the access key was most recently used.

This value is null if the access key has not been used.

accessKeyLastUsed_region :: Lens' AccessKeyLastUsed (Maybe Text) Source #

The Amazon Web Services Region where this access key was most recently used.

This value is N/A if the access key has not been used.

accessKeyLastUsed_serviceName :: Lens' AccessKeyLastUsed (Maybe Text) Source #

The name of the Amazon Web Services service with which this access key was most recently used.

This value is N/A if the access key has not been used.

AccessRules

accessRules_allowPublicOverrides :: Lens' AccessRules (Maybe Bool) Source #

A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

accessRules_getObject :: Lens' AccessRules (Maybe AccessType) Source #

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

AccountLevelBpaSync

accountLevelBpaSync_bpaImpactsLightsail :: Lens' AccountLevelBpaSync (Maybe Bool) Source #

A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.

accountLevelBpaSync_lastSyncedAt :: Lens' AccountLevelBpaSync (Maybe UTCTime) Source #

The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.

accountLevelBpaSync_message :: Lens' AccountLevelBpaSync (Maybe BPAStatusMessage) Source #

A message that provides a reason for a Failed or Defaulted synchronization status.

The following messages are possible:

  • SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.
  • DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
  • DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
  • Unknown - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.

accountLevelBpaSync_status :: Lens' AccountLevelBpaSync (Maybe AccountLevelBpaSyncStatus) Source #

The status of the account-level BPA synchronization.

The following statuses are possible:

  • InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.
  • NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
  • Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
  • Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active.

You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses.

AddOn

addOn_name :: Lens' AddOn (Maybe Text) Source #

The name of the add-on.

addOn_nextSnapshotTimeOfDay :: Lens' AddOn (Maybe Text) Source #

The next daily time an automatic snapshot will be created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

addOn_snapshotTimeOfDay :: Lens' AddOn (Maybe Text) Source #

The daily time when an automatic snapshot is created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

addOn_status :: Lens' AddOn (Maybe Text) Source #

The status of the add-on.

AddOnRequest

addOnRequest_autoSnapshotAddOnRequest :: Lens' AddOnRequest (Maybe AutoSnapshotAddOnRequest) Source #

An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.

addOnRequest_addOnType :: Lens' AddOnRequest AddOnType Source #

The add-on type.

Alarm

alarm_arn :: Lens' Alarm (Maybe Text) Source #

The Amazon Resource Name (ARN) of the alarm.

alarm_comparisonOperator :: Lens' Alarm (Maybe ComparisonOperator) Source #

The arithmetic operation used when comparing the specified statistic and threshold.

alarm_contactProtocols :: Lens' Alarm (Maybe [ContactProtocol]) Source #

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

alarm_createdAt :: Lens' Alarm (Maybe UTCTime) Source #

The timestamp when the alarm was created.

alarm_datapointsToAlarm :: Lens' Alarm (Maybe Int) Source #

The number of data points that must not within the specified threshold to trigger the alarm.

alarm_evaluationPeriods :: Lens' Alarm (Maybe Int) Source #

The number of periods over which data is compared to the specified threshold.

alarm_location :: Lens' Alarm (Maybe ResourceLocation) Source #

An object that lists information about the location of the alarm.

alarm_metricName :: Lens' Alarm (Maybe MetricName) Source #

The name of the metric associated with the alarm.

alarm_monitoredResourceInfo :: Lens' Alarm (Maybe MonitoredResourceInfo) Source #

An object that lists information about the resource monitored by the alarm.

alarm_name :: Lens' Alarm (Maybe Text) Source #

The name of the alarm.

alarm_notificationEnabled :: Lens' Alarm (Maybe Bool) Source #

Indicates whether the alarm is enabled.

alarm_notificationTriggers :: Lens' Alarm (Maybe [AlarmState]) Source #

The alarm states that trigger a notification.

alarm_period :: Lens' Alarm (Maybe Natural) Source #

The period, in seconds, over which the statistic is applied.

alarm_resourceType :: Lens' Alarm (Maybe ResourceType) Source #

The Lightsail resource type (e.g., Alarm).

alarm_state :: Lens' Alarm (Maybe AlarmState) Source #

The current state of the alarm.

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.

alarm_statistic :: Lens' Alarm (Maybe MetricStatistic) Source #

The statistic for the metric associated with the alarm.

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.

alarm_supportCode :: Lens' Alarm (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

alarm_threshold :: Lens' Alarm (Maybe Double) Source #

The value against which the specified statistic is compared.

alarm_treatMissingData :: Lens' Alarm (Maybe TreatMissingData) Source #

Specifies how the alarm handles 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.

alarm_unit :: Lens' Alarm (Maybe MetricUnit) Source #

The unit of the metric associated with the alarm.

AttachedDisk

attachedDisk_path :: Lens' AttachedDisk (Maybe Text) Source #

The path of the disk (e.g., /dev/xvdf).

attachedDisk_sizeInGb :: Lens' AttachedDisk (Maybe Int) Source #

The size of the disk in GB.

AutoSnapshotAddOnRequest

autoSnapshotAddOnRequest_snapshotTimeOfDay :: Lens' AutoSnapshotAddOnRequest (Maybe Text) Source #

The daily time when an automatic snapshot will be created.

Constraints:

  • Must be in HH:00 format, and in an hourly increment.
  • Specified in Coordinated Universal Time (UTC).
  • The snapshot will be automatically created between the time specified and up to 45 minutes after.

AutoSnapshotDetails

autoSnapshotDetails_createdAt :: Lens' AutoSnapshotDetails (Maybe UTCTime) Source #

The timestamp when the automatic snapshot was created.

autoSnapshotDetails_date :: Lens' AutoSnapshotDetails (Maybe Text) Source #

The date of the automatic snapshot in YYYY-MM-DD format.

autoSnapshotDetails_fromAttachedDisks :: Lens' AutoSnapshotDetails (Maybe [AttachedDisk]) Source #

An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.

autoSnapshotDetails_status :: Lens' AutoSnapshotDetails (Maybe AutoSnapshotStatus) Source #

The status of the automatic snapshot.

AvailabilityZone

availabilityZone_state :: Lens' AvailabilityZone (Maybe Text) Source #

The state of the Availability Zone.

availabilityZone_zoneName :: Lens' AvailabilityZone (Maybe Text) Source #

The name of the Availability Zone. The format is us-east-2a (case-sensitive).

Blueprint

blueprint_blueprintId :: Lens' Blueprint (Maybe Text) Source #

The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).

blueprint_description :: Lens' Blueprint (Maybe Text) Source #

The description of the blueprint.

blueprint_group :: Lens' Blueprint (Maybe Text) Source #

The group name of the blueprint (e.g., amazon-linux).

blueprint_isActive :: Lens' Blueprint (Maybe Bool) Source #

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

blueprint_licenseUrl :: Lens' Blueprint (Maybe Text) Source #

The end-user license agreement URL for the image or blueprint.

blueprint_minPower :: Lens' Blueprint (Maybe Int) Source #

The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.

blueprint_name :: Lens' Blueprint (Maybe Text) Source #

The friendly name of the blueprint (e.g., Amazon Linux).

blueprint_platform :: Lens' Blueprint (Maybe InstancePlatform) Source #

The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

blueprint_productUrl :: Lens' Blueprint (Maybe Text) Source #

The product URL to learn more about the image or blueprint.

blueprint_type :: Lens' Blueprint (Maybe BlueprintType) Source #

The type of the blueprint (e.g., os or app).

blueprint_version :: Lens' Blueprint (Maybe Text) Source #

The version number of the operating system, application, or stack (e.g., 2016.03.0).

blueprint_versionCode :: Lens' Blueprint (Maybe Text) Source #

The version code.

Bucket

bucket_ableToUpdateBundle :: Lens' Bucket (Maybe Bool) Source #

Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.

Use the UpdateBucketBundle action to change a bucket's bundle.

bucket_accessLogConfig :: Lens' Bucket (Maybe BucketAccessLogConfig) Source #

An object that describes the access log configuration for the bucket.

bucket_accessRules :: Lens' Bucket (Maybe AccessRules) Source #

An object that describes the access rules of the bucket.

bucket_arn :: Lens' Bucket (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bucket.

bucket_bundleId :: Lens' Bucket (Maybe Text) Source #

The ID of the bundle currently applied to the bucket.

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

Use the UpdateBucketBundle action to change the bundle of a bucket.

bucket_createdAt :: Lens' Bucket (Maybe UTCTime) Source #

The timestamp when the distribution was created.

bucket_location :: Lens' Bucket (Maybe ResourceLocation) Source #

An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

bucket_name :: Lens' Bucket (Maybe Text) Source #

The name of the bucket.

bucket_objectVersioning :: Lens' Bucket (Maybe Text) Source #

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

  • Enabled - Object versioning is enabled.
  • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.
  • NeverEnabled - Object versioning has never been enabled.

bucket_readonlyAccessAccounts :: Lens' Bucket (Maybe [Text]) Source #

An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

bucket_resourceType :: Lens' Bucket (Maybe Text) Source #

The Lightsail resource type of the bucket (for example, Bucket).

bucket_resourcesReceivingAccess :: Lens' Bucket (Maybe [ResourceReceivingAccess]) Source #

An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

bucket_state :: Lens' Bucket (Maybe BucketState) Source #

An object that describes the state of the bucket.

bucket_supportCode :: Lens' Bucket (Maybe Text) Source #

The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

bucket_tags :: Lens' Bucket (Maybe [Tag]) Source #

The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

bucket_url :: Lens' Bucket (Maybe Text) Source #

The URL of the bucket.

BucketAccessLogConfig

bucketAccessLogConfig_destination :: Lens' BucketAccessLogConfig (Maybe Text) Source #

The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.

This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.

bucketAccessLogConfig_prefix :: Lens' BucketAccessLogConfig (Maybe Text) Source #

The optional object prefix for the bucket access log.

The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).

This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.

bucketAccessLogConfig_enabled :: Lens' BucketAccessLogConfig Bool Source #

A Boolean value that indicates whether bucket access logging is enabled for the bucket.

BucketBundle

bucketBundle_bundleId :: Lens' BucketBundle (Maybe Text) Source #

The ID of the bundle.

bucketBundle_isActive :: Lens' BucketBundle (Maybe Bool) Source #

Indicates whether the bundle is active. Use for a new or existing bucket.

bucketBundle_name :: Lens' BucketBundle (Maybe Text) Source #

The name of the bundle.

bucketBundle_price :: Lens' BucketBundle (Maybe Double) Source #

The monthly price of the bundle, in US dollars.

bucketBundle_storagePerMonthInGb :: Lens' BucketBundle (Maybe Int) Source #

The storage size of the bundle, in GB.

bucketBundle_transferPerMonthInGb :: Lens' BucketBundle (Maybe Int) Source #

The monthly network transfer quota of the bundle.

BucketState

bucketState_code :: Lens' BucketState (Maybe Text) Source #

The state code of the bucket.

The following codes are possible:

  • OK - The bucket is in a running state.
  • Unknown - Creation of the bucket might have timed-out. You might want to delete the bucket and create a new one.

bucketState_message :: Lens' BucketState (Maybe Text) Source #

A message that describes the state of the bucket.

Bundle

bundle_bundleId :: Lens' Bundle (Maybe Text) Source #

The bundle ID (e.g., micro_1_0).

bundle_cpuCount :: Lens' Bundle (Maybe Int) Source #

The number of vCPUs included in the bundle (e.g., 2).

bundle_diskSizeInGb :: Lens' Bundle (Maybe Int) Source #

The size of the SSD (e.g., 30).

bundle_instanceType :: Lens' Bundle (Maybe Text) Source #

The Amazon EC2 instance type (e.g., t2.micro).

bundle_isActive :: Lens' Bundle (Maybe Bool) Source #

A Boolean value indicating whether the bundle is active.

bundle_name :: Lens' Bundle (Maybe Text) Source #

A friendly name for the bundle (e.g., Micro).

bundle_power :: Lens' Bundle (Maybe Int) Source #

A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.

bundle_price :: Lens' Bundle (Maybe Double) Source #

The price in US dollars (e.g., 5.0) of the bundle.

bundle_ramSizeInGb :: Lens' Bundle (Maybe Double) Source #

The amount of RAM in GB (e.g., 2.0).

bundle_supportedPlatforms :: Lens' Bundle (Maybe [InstancePlatform]) Source #

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle.

bundle_transferPerMonthInGb :: Lens' Bundle (Maybe Int) Source #

The data transfer rate per month in GB (e.g., 2000).

CacheBehavior

cacheBehavior_behavior :: Lens' CacheBehavior (Maybe BehaviorEnum) Source #

The cache behavior of the distribution.

The following cache behaviors can be specified:

  • cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
  • dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.

CacheBehaviorPerPath

cacheBehaviorPerPath_behavior :: Lens' CacheBehaviorPerPath (Maybe BehaviorEnum) Source #

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

  • cache - This behavior caches the specified path.
  • dont-cache - This behavior doesn't cache the specified path.

cacheBehaviorPerPath_path :: Lens' CacheBehaviorPerPath (Maybe Text) Source #

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

  • Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

    var/www/html/

  • Specify the following file to cache only the index page in the document root of an Apache web server.

    var/www/html/index.html

  • Specify the following to cache only the .html files in the document root of an Apache web server.

    var/www/html/*.html

  • Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

    var/www/html/images/*.jpg
    var/www/html/images/*.png
    var/www/html/images/*.gif

    Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

    var/www/html/images/

CacheSettings

cacheSettings_allowedHTTPMethods :: Lens' CacheSettings (Maybe Text) Source #

The HTTP methods that are processed and forwarded to the distribution's origin.

You can specify the following options:

  • GET,HEAD - The distribution forwards the GET and HEAD methods.
  • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.
  • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.

cacheSettings_cachedHTTPMethods :: Lens' CacheSettings (Maybe Text) Source #

The HTTP method responses that are cached by your distribution.

You can specify the following options:

  • GET,HEAD - The distribution caches responses to the GET and HEAD methods.
  • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

cacheSettings_defaultTTL :: Lens' CacheSettings (Maybe Integer) Source #

The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

cacheSettings_forwardedCookies :: Lens' CacheSettings (Maybe CookieObject) Source #

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.

cacheSettings_forwardedHeaders :: Lens' CacheSettings (Maybe HeaderObject) Source #

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.

cacheSettings_forwardedQueryStrings :: Lens' CacheSettings (Maybe QueryStringObject) Source #

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.

cacheSettings_maximumTTL :: Lens' CacheSettings (Maybe Integer) Source #

The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

cacheSettings_minimumTTL :: Lens' CacheSettings (Maybe Integer) Source #

The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.

Certificate

certificate_arn :: Lens' Certificate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the certificate.

certificate_createdAt :: Lens' Certificate (Maybe UTCTime) Source #

The timestamp when the certificate was created.

certificate_domainName :: Lens' Certificate (Maybe Text) Source #

The domain name of the certificate.

certificate_domainValidationRecords :: Lens' Certificate (Maybe [DomainValidationRecord]) Source #

An array of objects that describe the domain validation records of the certificate.

certificate_eligibleToRenew :: Lens' Certificate (Maybe Text) Source #

The renewal eligibility of the certificate.

certificate_inUseResourceCount :: Lens' Certificate (Maybe Int) Source #

The number of Lightsail resources that the certificate is attached to.

certificate_issuedAt :: Lens' Certificate (Maybe UTCTime) Source #

The timestamp when the certificate was issued.

certificate_issuerCA :: Lens' Certificate (Maybe Text) Source #

The certificate authority that issued the certificate.

certificate_keyAlgorithm :: Lens' Certificate (Maybe Text) Source #

The algorithm used to generate the key pair (the public and private key) of the certificate.

certificate_name :: Lens' Certificate (Maybe Text) Source #

The name of the certificate (e.g., my-certificate).

certificate_notAfter :: Lens' Certificate (Maybe UTCTime) Source #

The timestamp when the certificate expires.

certificate_notBefore :: Lens' Certificate (Maybe UTCTime) Source #

The timestamp when the certificate is first valid.

certificate_renewalSummary :: Lens' Certificate (Maybe RenewalSummary) Source #

An object that describes the status of the certificate renewal managed by Lightsail.

certificate_requestFailureReason :: Lens' Certificate (Maybe Text) Source #

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the Amazon Web Services Support Center to contact Amazon Web Services Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the Amazon Web Services Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.
  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

certificate_revocationReason :: Lens' Certificate (Maybe Text) Source #

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

certificate_revokedAt :: Lens' Certificate (Maybe UTCTime) Source #

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

certificate_serialNumber :: Lens' Certificate (Maybe Text) Source #

The serial number of the certificate.

certificate_status :: Lens' Certificate (Maybe CertificateStatus) Source #

The validation status of the certificate.

certificate_subjectAlternativeNames :: Lens' Certificate (Maybe [Text]) Source #

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

certificate_supportCode :: Lens' Certificate (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

certificate_tags :: Lens' Certificate (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

CertificateSummary

certificateSummary_certificateArn :: Lens' CertificateSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the certificate.

certificateSummary_certificateDetail :: Lens' CertificateSummary (Maybe Certificate) Source #

An object that describes a certificate in detail.

certificateSummary_certificateName :: Lens' CertificateSummary (Maybe Text) Source #

The name of the certificate.

certificateSummary_domainName :: Lens' CertificateSummary (Maybe Text) Source #

The domain name of the certificate.

certificateSummary_tags :: Lens' CertificateSummary (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

CloudFormationStackRecord

cloudFormationStackRecord_arn :: Lens' CloudFormationStackRecord (Maybe Text) Source #

The Amazon Resource Name (ARN) of the CloudFormation stack record.

cloudFormationStackRecord_createdAt :: Lens' CloudFormationStackRecord (Maybe UTCTime) Source #

The date when the CloudFormation stack record was created.

cloudFormationStackRecord_destinationInfo :: Lens' CloudFormationStackRecord (Maybe DestinationInfo) Source #

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.

cloudFormationStackRecord_location :: Lens' CloudFormationStackRecord (Maybe ResourceLocation) Source #

A list of objects describing the Availability Zone and Amazon Web Services Region of the CloudFormation stack record.

cloudFormationStackRecord_name :: Lens' CloudFormationStackRecord (Maybe Text) Source #

The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.

cloudFormationStackRecord_resourceType :: Lens' CloudFormationStackRecord (Maybe ResourceType) Source #

The Lightsail resource type (e.g., CloudFormationStackRecord).

cloudFormationStackRecord_sourceInfo :: Lens' CloudFormationStackRecord (Maybe [CloudFormationStackRecordSourceInfo]) Source #

A list of objects describing the source of the CloudFormation stack record.

cloudFormationStackRecord_state :: Lens' CloudFormationStackRecord (Maybe RecordState) Source #

The current state of the CloudFormation stack record.

CloudFormationStackRecordSourceInfo

cloudFormationStackRecordSourceInfo_arn :: Lens' CloudFormationStackRecordSourceInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) of the export snapshot record.

cloudFormationStackRecordSourceInfo_name :: Lens' CloudFormationStackRecordSourceInfo (Maybe Text) Source #

The name of the record.

cloudFormationStackRecordSourceInfo_resourceType :: Lens' CloudFormationStackRecordSourceInfo (Maybe CloudFormationStackRecordSourceType) Source #

The Lightsail resource type (e.g., ExportSnapshotRecord).

ContactMethod

contactMethod_arn :: Lens' ContactMethod (Maybe Text) Source #

The Amazon Resource Name (ARN) of the contact method.

contactMethod_contactEndpoint :: Lens' ContactMethod (Maybe Text) Source #

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

contactMethod_createdAt :: Lens' ContactMethod (Maybe UTCTime) Source #

The timestamp when the contact method was created.

contactMethod_location :: Lens' ContactMethod (Maybe ResourceLocation) Source #

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

contactMethod_name :: Lens' ContactMethod (Maybe Text) Source #

The name of the contact method.

contactMethod_protocol :: Lens' ContactMethod (Maybe ContactProtocol) Source #

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

contactMethod_resourceType :: Lens' ContactMethod (Maybe ResourceType) Source #

The Lightsail resource type (e.g., ContactMethod).

contactMethod_status :: Lens' ContactMethod (Maybe ContactMethodStatus) Source #

The current status of the contact method.

A contact method has the following possible status:

  • PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.
  • Valid - The contact method has been verified.
  • InValid - An attempt was made to verify the contact method, but the verification has expired.

contactMethod_supportCode :: Lens' ContactMethod (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.

Container

container_command :: Lens' Container (Maybe [Text]) Source #

The launch command for the container.

container_environment :: Lens' Container (Maybe (HashMap Text Text)) Source #

The environment variables of the container.

container_image :: Lens' Container (Maybe Text) Source #

The name of the image used for the container.

Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.

Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx.

container_ports :: Lens' Container (Maybe (HashMap Text ContainerServiceProtocol)) Source #

The open firewall ports of the container.

ContainerImage

containerImage_createdAt :: Lens' ContainerImage (Maybe UTCTime) Source #

The timestamp when the container image was created.

containerImage_digest :: Lens' ContainerImage (Maybe Text) Source #

The digest of the container image.

containerImage_image :: Lens' ContainerImage (Maybe Text) Source #

The name of the container image.

ContainerService

containerService_arn :: Lens' ContainerService (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container service.

containerService_containerServiceName :: Lens' ContainerService (Maybe Text) Source #

The name of the container service.

containerService_createdAt :: Lens' ContainerService (Maybe UTCTime) Source #

The timestamp when the container service was created.

containerService_currentDeployment :: Lens' ContainerService (Maybe ContainerServiceDeployment) Source #

An object that describes the current container deployment of the container service.

containerService_isDisabled :: Lens' ContainerService (Maybe Bool) Source #

A Boolean value indicating whether the container service is disabled.

containerService_location :: Lens' ContainerService (Maybe ResourceLocation) Source #

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

containerService_nextDeployment :: Lens' ContainerService (Maybe ContainerServiceDeployment) Source #

An object that describes the next deployment of the container service.

This value is null when there is no deployment in a pending state.

containerService_power :: Lens' ContainerService (Maybe ContainerServicePowerName) Source #

The power specification of the container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

containerService_powerId :: Lens' ContainerService (Maybe Text) Source #

The ID of the power of the container service.

containerService_principalArn :: Lens' ContainerService (Maybe Text) Source #

The principal ARN of the container service.

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your service permission to access resources in your standard Amazon Web Services account.

containerService_privateDomainName :: Lens' ContainerService (Maybe Text) Source #

The private domain name of the container service.

The private domain name is accessible only by other resources within the default virtual private cloud (VPC) of your Lightsail account.

containerService_privateRegistryAccess :: Lens' ContainerService (Maybe PrivateRegistryAccess) Source #

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

containerService_publicDomainNames :: Lens' ContainerService (Maybe (HashMap Text [Text])) Source #

The public domain name of 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.

See CreateContainerService or UpdateContainerService for information about how to specify public domain names for your Lightsail container service.

containerService_resourceType :: Lens' ContainerService (Maybe ResourceType) Source #

The Lightsail resource type of the container service (i.e., ContainerService).

containerService_scale :: Lens' ContainerService (Maybe Natural) Source #

The scale specification of the container service.

The scale specifies the allocated compute nodes of the container service.

containerService_state :: Lens' ContainerService (Maybe ContainerServiceState) Source #

The current state of the container service.

The following container service states are possible:

  • PENDING - The container service is being created.
  • READY - The container service is running but it does not have an active container deployment.
  • DEPLOYING - The container service is launching a container deployment.
  • RUNNING - The container service is running and it has an active container deployment.
  • UPDATING - The container service capacity or its custom domains are being updated.
  • DELETING - The container service is being deleted.
  • DISABLED - The container service is disabled, and its active deployment and containers, if any, are shut down.

containerService_stateDetail :: Lens' ContainerService (Maybe ContainerServiceStateDetail) Source #

An object that describes the current state of the container service.

The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

containerService_tags :: Lens' ContainerService (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

containerService_url :: Lens' ContainerService (Maybe Text) Source #

The publicly accessible URL of the container service.

If no public endpoint is specified in the currentDeployment, this URL returns a 404 response.

ContainerServiceDeployment

containerServiceDeployment_containers :: Lens' ContainerServiceDeployment (Maybe (HashMap Text Container)) Source #

An object that describes the configuration for the containers of the deployment.

containerServiceDeployment_createdAt :: Lens' ContainerServiceDeployment (Maybe UTCTime) Source #

The timestamp when the deployment was created.

containerServiceDeployment_publicEndpoint :: Lens' ContainerServiceDeployment (Maybe ContainerServiceEndpoint) Source #

An object that describes the endpoint of the deployment.

containerServiceDeployment_state :: Lens' ContainerServiceDeployment (Maybe ContainerServiceDeploymentState) Source #

The state of the deployment.

A deployment can be in one of the following states:

  • Activating - The deployment is being created.
  • Active - The deployment was successfully created, and it's currently running on the container service. The container service can have only one deployment in an active state at a time.
  • Inactive - The deployment was previously successfully created, but it is not currently running on the container service.
  • Failed - The deployment failed. Use the GetContainerLog action to view the log events for the containers in the deployment to try to determine the reason for the failure.

containerServiceDeployment_version :: Lens' ContainerServiceDeployment (Maybe Int) Source #

The version number of the deployment.

ContainerServiceDeploymentRequest

containerServiceDeploymentRequest_containers :: Lens' ContainerServiceDeploymentRequest (Maybe (HashMap Text Container)) Source #

An object that describes the configuration for the containers of the deployment.

containerServiceDeploymentRequest_publicEndpoint :: Lens' ContainerServiceDeploymentRequest (Maybe EndpointRequest) Source #

An object that describes the endpoint of the deployment.

ContainerServiceECRImagePullerRole

containerServiceECRImagePullerRole_isActive :: Lens' ContainerServiceECRImagePullerRole (Maybe Bool) Source #

A Boolean value that indicates whether the role is activated.

containerServiceECRImagePullerRole_principalArn :: Lens' ContainerServiceECRImagePullerRole (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role, if it is activated.

ContainerServiceECRImagePullerRoleRequest

containerServiceECRImagePullerRoleRequest_isActive :: Lens' ContainerServiceECRImagePullerRoleRequest (Maybe Bool) Source #

A Boolean value that indicates whether to activate the role.

ContainerServiceEndpoint

containerServiceEndpoint_containerName :: Lens' ContainerServiceEndpoint (Maybe Text) Source #

The name of the container entry of the deployment that the endpoint configuration applies to.

containerServiceEndpoint_containerPort :: Lens' ContainerServiceEndpoint (Maybe Int) Source #

The port of the specified container to which traffic is forwarded to.

containerServiceEndpoint_healthCheck :: Lens' ContainerServiceEndpoint (Maybe ContainerServiceHealthCheckConfig) Source #

An object that describes the health check configuration of the container.

ContainerServiceHealthCheckConfig

containerServiceHealthCheckConfig_healthyThreshold :: Lens' ContainerServiceHealthCheckConfig (Maybe Int) Source #

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

containerServiceHealthCheckConfig_intervalSeconds :: Lens' ContainerServiceHealthCheckConfig (Maybe Int) Source #

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

containerServiceHealthCheckConfig_path :: Lens' ContainerServiceHealthCheckConfig (Maybe Text) Source #

The path on the container on which to perform the health check. The default value is /.

containerServiceHealthCheckConfig_successCodes :: Lens' ContainerServiceHealthCheckConfig (Maybe Text) Source #

The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

containerServiceHealthCheckConfig_timeoutSeconds :: Lens' ContainerServiceHealthCheckConfig (Maybe Int) Source #

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

containerServiceHealthCheckConfig_unhealthyThreshold :: Lens' ContainerServiceHealthCheckConfig (Maybe Int) Source #

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

ContainerServiceLogEvent

containerServiceLogEvent_createdAt :: Lens' ContainerServiceLogEvent (Maybe UTCTime) Source #

The timestamp when the container service log event was created.

containerServiceLogEvent_message :: Lens' ContainerServiceLogEvent (Maybe Text) Source #

The message of the container service log event.

ContainerServicePower

containerServicePower_cpuCount :: Lens' ContainerServicePower (Maybe Double) Source #

The number of vCPUs included in the power.

containerServicePower_isActive :: Lens' ContainerServicePower (Maybe Bool) Source #

A Boolean value indicating whether the power is active and can be specified for container services.

containerServicePower_name :: Lens' ContainerServicePower (Maybe Text) Source #

The friendly name of the power (e.g., nano).

containerServicePower_powerId :: Lens' ContainerServicePower (Maybe Text) Source #

The ID of the power (e.g., nano-1).

containerServicePower_price :: Lens' ContainerServicePower (Maybe Double) Source #

The monthly price of the power in USD.

containerServicePower_ramSizeInGb :: Lens' ContainerServicePower (Maybe Double) Source #

The amount of RAM (in GB) of the power.

ContainerServiceRegistryLogin

containerServiceRegistryLogin_expiresAt :: Lens' ContainerServiceRegistryLogin (Maybe UTCTime) Source #

The timestamp of when the container image registry username and password expire.

The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials using the CreateContainerServiceRegistryLogin action.

containerServiceRegistryLogin_password :: Lens' ContainerServiceRegistryLogin (Maybe Text) Source #

The container service registry password to use to push container images to the container image registry of a Lightsail account

containerServiceRegistryLogin_registry :: Lens' ContainerServiceRegistryLogin (Maybe Text) Source #

The address to use to push container images to the container image registry of a Lightsail account.

containerServiceRegistryLogin_username :: Lens' ContainerServiceRegistryLogin (Maybe Text) Source #

The container service registry username to use to push container images to the container image registry of a Lightsail account.

ContainerServiceStateDetail

containerServiceStateDetail_code :: Lens' ContainerServiceStateDetail (Maybe ContainerServiceStateDetailCode) Source #

The state code of the container service.

The following state codes are possible:

  • The following state codes are possible if your container service is in a DEPLOYING or UPDATING state:

    • CREATING_SYSTEM_RESOURCES - The system resources for your container service are being created.
    • CREATING_NETWORK_INFRASTRUCTURE - The network infrastructure for your container service are being created.
    • PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container service is being created.
    • PROVISIONING_SERVICE - Your container service is being provisioned.
    • CREATING_DEPLOYMENT - Your deployment is being created on your container service.
    • EVALUATING_HEALTH_CHECK - The health of your deployment is being evaluated.
    • ACTIVATING_DEPLOYMENT - Your deployment is being activated.

  • The following state codes are possible if your container service is in a PENDING state:

    • CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate required for your container service exceeds the maximum number of certificates allowed for your account.
    • UNKNOWN_ERROR - An error was experienced when your container service was being created.

containerServiceStateDetail_message :: Lens' ContainerServiceStateDetail (Maybe Text) Source #

A message that provides more information for the state code.

The state detail is populated only when a container service is in a PENDING, DEPLOYING, or UPDATING state.

CookieObject

cookieObject_cookiesAllowList :: Lens' CookieObject (Maybe [Text]) Source #

The specific cookies to forward to your distribution's origin.

cookieObject_option :: Lens' CookieObject (Maybe ForwardValues) Source #

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

DestinationInfo

destinationInfo_id :: Lens' DestinationInfo (Maybe Text) Source #

The ID of the resource created at the destination.

destinationInfo_service :: Lens' DestinationInfo (Maybe Text) Source #

The destination service of the record.

Disk

disk_addOns :: Lens' Disk (Maybe [AddOn]) Source #

An array of objects representing the add-ons enabled on the disk.

disk_arn :: Lens' Disk (Maybe Text) Source #

The Amazon Resource Name (ARN) of the disk.

disk_attachedTo :: Lens' Disk (Maybe Text) Source #

The resources to which the disk is attached.

disk_attachmentState :: Lens' Disk (Maybe Text) Source #

(Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

disk_createdAt :: Lens' Disk (Maybe UTCTime) Source #

The date when the disk was created.

disk_gbInUse :: Lens' Disk (Maybe Int) Source #

(Deprecated) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

disk_iops :: Lens' Disk (Maybe Int) Source #

The input/output operations per second (IOPS) of the disk.

disk_isAttached :: Lens' Disk (Maybe Bool) Source #

A Boolean value indicating whether the disk is attached.

disk_isSystemDisk :: Lens' Disk (Maybe Bool) Source #

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

disk_location :: Lens' Disk (Maybe ResourceLocation) Source #

The AWS Region and Availability Zone where the disk is located.

disk_name :: Lens' Disk (Maybe Text) Source #

The unique name of the disk.

disk_path :: Lens' Disk (Maybe Text) Source #

The disk path.

disk_resourceType :: Lens' Disk (Maybe ResourceType) Source #

The Lightsail resource type (e.g., Disk).

disk_sizeInGb :: Lens' Disk (Maybe Int) Source #

The size of the disk in GB.

disk_state :: Lens' Disk (Maybe DiskState) Source #

Describes the status of the disk.

disk_supportCode :: Lens' Disk (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

disk_tags :: Lens' Disk (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

DiskInfo

diskInfo_isSystemDisk :: Lens' DiskInfo (Maybe Bool) Source #

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

diskInfo_name :: Lens' DiskInfo (Maybe Text) Source #

The disk name.

diskInfo_path :: Lens' DiskInfo (Maybe Text) Source #

The disk path.

diskInfo_sizeInGb :: Lens' DiskInfo (Maybe Int) Source #

The size of the disk in GB (e.g., 32).

DiskMap

diskMap_newDiskName :: Lens' DiskMap (Maybe Text) Source #

The new disk name (e.g., my-new-disk).

diskMap_originalDiskPath :: Lens' DiskMap (Maybe Text) Source #

The original disk path exposed to the instance (for example, /dev/sdh).

DiskSnapshot

diskSnapshot_arn :: Lens' DiskSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the disk snapshot.

diskSnapshot_createdAt :: Lens' DiskSnapshot (Maybe UTCTime) Source #

The date when the disk snapshot was created.

diskSnapshot_fromDiskArn :: Lens' DiskSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

diskSnapshot_fromDiskName :: Lens' DiskSnapshot (Maybe Text) Source #

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

diskSnapshot_fromInstanceArn :: Lens' DiskSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

diskSnapshot_fromInstanceName :: Lens' DiskSnapshot (Maybe Text) Source #

The unique name of the source instance from which the disk (system volume) snapshot was created.

diskSnapshot_isFromAutoSnapshot :: Lens' DiskSnapshot (Maybe Bool) Source #

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

diskSnapshot_location :: Lens' DiskSnapshot (Maybe ResourceLocation) Source #

The AWS Region and Availability Zone where the disk snapshot was created.

diskSnapshot_name :: Lens' DiskSnapshot (Maybe Text) Source #

The name of the disk snapshot (e.g., my-disk-snapshot).

diskSnapshot_progress :: Lens' DiskSnapshot (Maybe Text) Source #

The progress of the snapshot.

diskSnapshot_resourceType :: Lens' DiskSnapshot (Maybe ResourceType) Source #

The Lightsail resource type (e.g., DiskSnapshot).

diskSnapshot_sizeInGb :: Lens' DiskSnapshot (Maybe Int) Source #

The size of the disk in GB.

diskSnapshot_state :: Lens' DiskSnapshot (Maybe DiskSnapshotState) Source #

The status of the disk snapshot operation.

diskSnapshot_supportCode :: Lens' DiskSnapshot (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

diskSnapshot_tags :: Lens' DiskSnapshot (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

DiskSnapshotInfo

diskSnapshotInfo_sizeInGb :: Lens' DiskSnapshotInfo (Maybe Int) Source #

The size of the disk in GB (e.g., 32).

DistributionBundle

distributionBundle_bundleId :: Lens' DistributionBundle (Maybe Text) Source #

The ID of the bundle.

distributionBundle_isActive :: Lens' DistributionBundle (Maybe Bool) Source #

Indicates whether the bundle is active, and can be specified for a new or existing distribution.

distributionBundle_name :: Lens' DistributionBundle (Maybe Text) Source #

The name of the distribution bundle.

distributionBundle_price :: Lens' DistributionBundle (Maybe Double) Source #

The monthly price, in US dollars, of the bundle.

distributionBundle_transferPerMonthInGb :: Lens' DistributionBundle (Maybe Int) Source #

The monthly network transfer quota of the bundle.

DnsRecordCreationState

dnsRecordCreationState_code :: Lens' DnsRecordCreationState (Maybe DnsRecordCreationStateCode) Source #

The status code for the automated DNS record creation.

Following are the possible values:

  • SUCCEEDED - The validation records were successfully added to the domain.
  • STARTED - The automatic DNS record creation has started.
  • FAILED - The validation records failed to be added to the domain.

dnsRecordCreationState_message :: Lens' DnsRecordCreationState (Maybe Text) Source #

The message that describes the reason for the status code.

Domain

domain_arn :: Lens' Domain (Maybe Text) Source #

The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

domain_createdAt :: Lens' Domain (Maybe UTCTime) Source #

The date when the domain recordset was created.

domain_domainEntries :: Lens' Domain (Maybe [DomainEntry]) Source #

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

domain_location :: Lens' Domain (Maybe ResourceLocation) Source #

The AWS Region and Availability Zones where the domain recordset was created.

domain_name :: Lens' Domain (Maybe Text) Source #

The name of the domain.

domain_registeredDomainDelegationInfo :: Lens' Domain (Maybe RegisteredDomainDelegationInfo) Source #

An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone.

domain_resourceType :: Lens' Domain (Maybe ResourceType) Source #

The resource type.

domain_supportCode :: Lens' Domain (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

domain_tags :: Lens' Domain (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

DomainEntry

domainEntry_id :: Lens' DomainEntry (Maybe Text) Source #

The ID of the domain recordset entry.

domainEntry_isAlias :: Lens' DomainEntry (Maybe Bool) Source #

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer.

domainEntry_name :: Lens' DomainEntry (Maybe Text) Source #

The name of the domain.

domainEntry_options :: Lens' DomainEntry (Maybe (HashMap Text Text)) Source #

(Deprecated) The options for the domain entry.

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

domainEntry_target :: Lens' DomainEntry (Maybe Text) Source #

The target IP address (e.g., 192.0.2.0), or AWS name server (e.g., ns-111.awsdns-22.com.).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

domainEntry_type :: Lens' DomainEntry (Maybe Text) Source #

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

  • A
  • AAAA
  • CNAME
  • MX
  • NS
  • SOA
  • SRV
  • TXT

DomainValidationRecord

domainValidationRecord_dnsRecordCreationState :: Lens' DomainValidationRecord (Maybe DnsRecordCreationState) Source #

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

domainValidationRecord_domainName :: Lens' DomainValidationRecord (Maybe Text) Source #

The domain name of the certificate validation record. For example, example.com or www.example.com.

domainValidationRecord_resourceRecord :: Lens' DomainValidationRecord (Maybe ResourceRecord) Source #

An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.

domainValidationRecord_validationStatus :: Lens' DomainValidationRecord (Maybe CertificateDomainValidationStatus) Source #

The validation status of the record.

EndpointRequest

endpointRequest_healthCheck :: Lens' EndpointRequest (Maybe ContainerServiceHealthCheckConfig) Source #

An object that describes the health check configuration of the container.

endpointRequest_containerName :: Lens' EndpointRequest Text Source #

The name of the container for the endpoint.

endpointRequest_containerPort :: Lens' EndpointRequest Int Source #

The port of the container to which traffic is forwarded to.

ExportSnapshotRecord

exportSnapshotRecord_arn :: Lens' ExportSnapshotRecord (Maybe Text) Source #

The Amazon Resource Name (ARN) of the export snapshot record.

exportSnapshotRecord_createdAt :: Lens' ExportSnapshotRecord (Maybe UTCTime) Source #

The date when the export snapshot record was created.

exportSnapshotRecord_destinationInfo :: Lens' ExportSnapshotRecord (Maybe DestinationInfo) Source #

A list of objects describing the destination of the export snapshot record.

exportSnapshotRecord_location :: Lens' ExportSnapshotRecord (Maybe ResourceLocation) Source #

The AWS Region and Availability Zone where the export snapshot record is located.

exportSnapshotRecord_name :: Lens' ExportSnapshotRecord (Maybe Text) Source #

The export snapshot record name.

exportSnapshotRecord_resourceType :: Lens' ExportSnapshotRecord (Maybe ResourceType) Source #

The Lightsail resource type (e.g., ExportSnapshotRecord).

exportSnapshotRecord_sourceInfo :: Lens' ExportSnapshotRecord (Maybe ExportSnapshotRecordSourceInfo) Source #

A list of objects describing the source of the export snapshot record.

exportSnapshotRecord_state :: Lens' ExportSnapshotRecord (Maybe RecordState) Source #

The state of the export snapshot record.

ExportSnapshotRecordSourceInfo

exportSnapshotRecordSourceInfo_arn :: Lens' ExportSnapshotRecordSourceInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

exportSnapshotRecordSourceInfo_createdAt :: Lens' ExportSnapshotRecordSourceInfo (Maybe UTCTime) Source #

The date when the source instance or disk snapshot was created.

exportSnapshotRecordSourceInfo_diskSnapshotInfo :: Lens' ExportSnapshotRecordSourceInfo (Maybe DiskSnapshotInfo) Source #

A list of objects describing a disk snapshot.

exportSnapshotRecordSourceInfo_fromResourceArn :: Lens' ExportSnapshotRecordSourceInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

exportSnapshotRecordSourceInfo_fromResourceName :: Lens' ExportSnapshotRecordSourceInfo (Maybe Text) Source #

The name of the snapshot's source instance or disk.

exportSnapshotRecordSourceInfo_instanceSnapshotInfo :: Lens' ExportSnapshotRecordSourceInfo (Maybe InstanceSnapshotInfo) Source #

A list of objects describing an instance snapshot.

exportSnapshotRecordSourceInfo_name :: Lens' ExportSnapshotRecordSourceInfo (Maybe Text) Source #

The name of the source instance or disk snapshot.

exportSnapshotRecordSourceInfo_resourceType :: Lens' ExportSnapshotRecordSourceInfo (Maybe ExportSnapshotRecordSourceType) Source #

The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).

HeaderObject

headerObject_headersAllowList :: Lens' HeaderObject (Maybe [HeaderEnum]) Source #

The specific headers to forward to your distribution's origin.

headerObject_option :: Lens' HeaderObject (Maybe ForwardValues) Source #

The headers that you want your distribution to forward to your origin and base caching on.

You can configure your distribution to do one of the following:

  • all - Forward all headers to your origin.
  • none - Forward only the default headers.
  • allow-list - Forward only the headers you specify using the headersAllowList parameter.

HostKeyAttributes

hostKeyAttributes_algorithm :: Lens' HostKeyAttributes (Maybe Text) Source #

The SSH host key algorithm or the RDP certificate format.

For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert.

hostKeyAttributes_fingerprintSHA1 :: Lens' HostKeyAttributes (Maybe Text) Source #

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-1 SSH fingerprint:

    SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0

  • Example of an SHA-1 RDP fingerprint:

    af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45

hostKeyAttributes_fingerprintSHA256 :: Lens' HostKeyAttributes (Maybe Text) Source #

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-256 SSH fingerprint:

    SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o

  • Example of an SHA-256 RDP fingerprint:

    03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68

hostKeyAttributes_notValidAfter :: Lens' HostKeyAttributes (Maybe UTCTime) Source #

The returned RDP certificate is not valid after this point in time.

This value is listed only for RDP certificates.

hostKeyAttributes_notValidBefore :: Lens' HostKeyAttributes (Maybe UTCTime) Source #

The returned RDP certificate is valid after this point in time.

This value is listed only for RDP certificates.

hostKeyAttributes_publicKey :: Lens' HostKeyAttributes (Maybe Text) Source #

The public SSH host key or the RDP certificate.

hostKeyAttributes_witnessedAt :: Lens' HostKeyAttributes (Maybe UTCTime) Source #

The time that the SSH host key or RDP certificate was recorded by Lightsail.

InputOrigin

inputOrigin_name :: Lens' InputOrigin (Maybe Text) Source #

The name of the origin resource.

inputOrigin_protocolPolicy :: Lens' InputOrigin (Maybe OriginProtocolPolicyEnum) Source #

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

inputOrigin_regionName :: Lens' InputOrigin (Maybe RegionName) Source #

The AWS Region name of the origin resource.

Instance

instance_addOns :: Lens' Instance (Maybe [AddOn]) Source #

An array of objects representing the add-ons enabled on the instance.

instance_arn :: Lens' Instance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

instance_blueprintId :: Lens' Instance (Maybe Text) Source #

The blueprint ID (e.g., os_amlinux_2016_03).

instance_blueprintName :: Lens' Instance (Maybe Text) Source #

The friendly name of the blueprint (e.g., Amazon Linux).

instance_bundleId :: Lens' Instance (Maybe Text) Source #

The bundle for the instance (e.g., micro_1_0).

instance_createdAt :: Lens' Instance (Maybe UTCTime) Source #

The timestamp when the instance was created (e.g., 1479734909.17) in Unix time format.

instance_hardware :: Lens' Instance (Maybe InstanceHardware) Source #

The size of the vCPU and the amount of RAM for the instance.

instance_ipAddressType :: Lens' Instance (Maybe IpAddressType) Source #

The IP address type of the instance.

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

instance_ipv6Addresses :: Lens' Instance (Maybe [Text]) Source #

The IPv6 addresses of the instance.

instance_isStaticIp :: Lens' Instance (Maybe Bool) Source #

A Boolean value indicating whether this instance has a static IP assigned to it.

instance_location :: Lens' Instance (Maybe ResourceLocation) Source #

The region name and Availability Zone where the instance is located.

instance_metadataOptions :: Lens' Instance (Maybe InstanceMetadataOptions) Source #

The metadata options for the Amazon Lightsail instance.

instance_name :: Lens' Instance (Maybe Text) Source #

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

instance_networking :: Lens' Instance (Maybe InstanceNetworking) Source #

Information about the public ports and monthly data transfer rates for the instance.

instance_privateIpAddress :: Lens' Instance (Maybe Text) Source #

The private IP address of the instance.

instance_publicIpAddress :: Lens' Instance (Maybe Text) Source #

The public IP address of the instance.

instance_resourceType :: Lens' Instance (Maybe ResourceType) Source #

The type of resource (usually Instance).

instance_sshKeyName :: Lens' Instance (Maybe Text) Source #

The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).

instance_state :: Lens' Instance (Maybe InstanceState) Source #

The status code and the state (e.g., running) for the instance.

instance_supportCode :: Lens' Instance (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

instance_tags :: Lens' Instance (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

instance_username :: Lens' Instance (Maybe Text) Source #

The user name for connecting to the instance (e.g., ec2-user).

InstanceAccessDetails

instanceAccessDetails_certKey :: Lens' InstanceAccessDetails (Maybe Text) Source #

For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.

instanceAccessDetails_expiresAt :: Lens' InstanceAccessDetails (Maybe UTCTime) Source #

For SSH access, the date on which the temporary keys expire.

instanceAccessDetails_hostKeys :: Lens' InstanceAccessDetails (Maybe [HostKeyAttributes]) Source #

Describes the public SSH host keys or the RDP certificate.

instanceAccessDetails_instanceName :: Lens' InstanceAccessDetails (Maybe Text) Source #

The name of this Amazon Lightsail instance.

instanceAccessDetails_ipAddress :: Lens' InstanceAccessDetails (Maybe Text) Source #

The public IP address of the Amazon Lightsail instance.

instanceAccessDetails_password :: Lens' InstanceAccessDetails (Maybe Text) Source #

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string.

If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

instanceAccessDetails_passwordData :: Lens' InstanceAccessDetails (Maybe PasswordData) Source #

For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.

instanceAccessDetails_privateKey :: Lens' InstanceAccessDetails (Maybe Text) Source #

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).

instanceAccessDetails_protocol :: Lens' InstanceAccessDetails (Maybe InstanceAccessProtocol) Source #

The protocol for these Amazon Lightsail instance access details.

instanceAccessDetails_username :: Lens' InstanceAccessDetails (Maybe Text) Source #

The user name to use when logging in to the Amazon Lightsail instance.

InstanceEntry

instanceEntry_userData :: Lens' InstanceEntry (Maybe Text) Source #

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.

instanceEntry_sourceName :: Lens' InstanceEntry Text Source #

The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.

Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack.

instanceEntry_instanceType :: Lens' InstanceEntry Text Source #

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

instanceEntry_portInfoSource :: Lens' InstanceEntry PortInfoSourceType Source #

The port configuration to use for the new Amazon EC2 instance.

The following configuration options are available:

  • DEFAULT - Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2.
  • INSTANCE - Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2.
  • NONE - Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.
  • CLOSED - All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.

If you configured lightsail-connect as a cidrListAliases on your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance.

instanceEntry_availabilityZone :: Lens' InstanceEntry Text Source #

The Availability Zone for the new Amazon EC2 instance.

InstanceHardware

instanceHardware_cpuCount :: Lens' InstanceHardware (Maybe Int) Source #

The number of vCPUs the instance has.

instanceHardware_disks :: Lens' InstanceHardware (Maybe [Disk]) Source #

The disks attached to the instance.

instanceHardware_ramSizeInGb :: Lens' InstanceHardware (Maybe Double) Source #

The amount of RAM in GB on the instance (e.g., 1.0).

InstanceHealthSummary

instanceHealthSummary_instanceHealth :: Lens' InstanceHealthSummary (Maybe InstanceHealthState) Source #

Describes the overall instance health. Valid values are below.

instanceHealthSummary_instanceHealthReason :: Lens' InstanceHealthSummary (Maybe InstanceHealthReason) Source #

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.
  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
  • Instance.Timeout - The health check requests timed out.
  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.
  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.
  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.
  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.
  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

instanceHealthSummary_instanceName :: Lens' InstanceHealthSummary (Maybe Text) Source #

The name of the Lightsail instance for which you are requesting health check data.

InstanceMetadataOptions

instanceMetadataOptions_httpEndpoint :: Lens' InstanceMetadataOptions (Maybe HttpEndpoint) Source #

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

instanceMetadataOptions_httpProtocolIpv6 :: Lens' InstanceMetadataOptions (Maybe HttpProtocolIpv6) Source #

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Int) Source #

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.

instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe HttpTokens) Source #

The state of token usage for your instance metadata requests.

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.

Not all instance blueprints in Lightsail support version 2.0 credentials. Use the MetadataNoToken instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

instanceMetadataOptions_state :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataState) Source #

The state of the metadata option changes.

The following states are possible:

  • pending - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.
  • applied - The metadata options have been successfully applied to the instance.

InstanceNetworking

instanceNetworking_monthlyTransfer :: Lens' InstanceNetworking (Maybe MonthlyTransfer) Source #

The amount of data in GB allocated for monthly data transfers.

instanceNetworking_ports :: Lens' InstanceNetworking (Maybe [InstancePortInfo]) Source #

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

InstancePortInfo

instancePortInfo_accessDirection :: Lens' InstancePortInfo (Maybe AccessDirection) Source #

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

instancePortInfo_accessFrom :: Lens' InstancePortInfo (Maybe Text) Source #

The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom if a specific IP address or range of IP addresses is allowed.

instancePortInfo_accessType :: Lens' InstancePortInfo (Maybe PortAccessType) Source #

The type of access (Public or Private).

instancePortInfo_cidrListAliases :: Lens' InstancePortInfo (Maybe [Text]) Source #

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

instancePortInfo_cidrs :: Lens' InstancePortInfo (Maybe [Text]) Source #

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

instancePortInfo_commonName :: Lens' InstancePortInfo (Maybe Text) Source #

The common name of the port information.

instancePortInfo_fromPort :: Lens' InstancePortInfo (Maybe Int) Source #

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535
  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

instancePortInfo_ipv6Cidrs :: Lens' InstancePortInfo (Maybe [Text]) Source #

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

instancePortInfo_protocol :: Lens' InstancePortInfo (Maybe NetworkProtocol) Source #

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

instancePortInfo_toPort :: Lens' InstancePortInfo (Maybe Int) Source #

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535
  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

InstancePortState

instancePortState_cidrListAliases :: Lens' InstancePortState (Maybe [Text]) Source #

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

instancePortState_cidrs :: Lens' InstancePortState (Maybe [Text]) Source #

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

instancePortState_fromPort :: Lens' InstancePortState (Maybe Int) Source #

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535
  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

instancePortState_ipv6Cidrs :: Lens' InstancePortState (Maybe [Text]) Source #

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

instancePortState_protocol :: Lens' InstancePortState (Maybe NetworkProtocol) Source #

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

instancePortState_state :: Lens' InstancePortState (Maybe PortState) Source #

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

instancePortState_toPort :: Lens' InstancePortState (Maybe Int) Source #

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535
  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

InstanceSnapshot

instanceSnapshot_arn :: Lens' InstanceSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

instanceSnapshot_createdAt :: Lens' InstanceSnapshot (Maybe UTCTime) Source #

The timestamp when the snapshot was created (e.g., 1479907467.024).

instanceSnapshot_fromAttachedDisks :: Lens' InstanceSnapshot (Maybe [Disk]) Source #

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

instanceSnapshot_fromBlueprintId :: Lens' InstanceSnapshot (Maybe Text) Source #

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

instanceSnapshot_fromBundleId :: Lens' InstanceSnapshot (Maybe Text) Source #

The bundle ID from which you created the snapshot (e.g., micro_1_0).

instanceSnapshot_fromInstanceArn :: Lens' InstanceSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

instanceSnapshot_fromInstanceName :: Lens' InstanceSnapshot (Maybe Text) Source #

The instance from which the snapshot was created.

instanceSnapshot_isFromAutoSnapshot :: Lens' InstanceSnapshot (Maybe Bool) Source #

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

instanceSnapshot_location :: Lens' InstanceSnapshot (Maybe ResourceLocation) Source #

The region name and Availability Zone where you created the snapshot.

instanceSnapshot_name :: Lens' InstanceSnapshot (Maybe Text) Source #

The name of the snapshot.

instanceSnapshot_progress :: Lens' InstanceSnapshot (Maybe Text) Source #

The progress of the snapshot.

This is populated only for disk snapshots, and is null for instance snapshots.

instanceSnapshot_resourceType :: Lens' InstanceSnapshot (Maybe ResourceType) Source #

The type of resource (usually InstanceSnapshot).

instanceSnapshot_sizeInGb :: Lens' InstanceSnapshot (Maybe Int) Source #

The size in GB of the SSD.

instanceSnapshot_state :: Lens' InstanceSnapshot (Maybe InstanceSnapshotState) Source #

The state the snapshot is in.

instanceSnapshot_supportCode :: Lens' InstanceSnapshot (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

instanceSnapshot_tags :: Lens' InstanceSnapshot (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

InstanceSnapshotInfo

instanceSnapshotInfo_fromBlueprintId :: Lens' InstanceSnapshotInfo (Maybe Text) Source #

The blueprint ID from which the source instance (e.g., os_debian_8_3).

instanceSnapshotInfo_fromBundleId :: Lens' InstanceSnapshotInfo (Maybe Text) Source #

The bundle ID from which the source instance was created (e.g., micro_1_0).

instanceSnapshotInfo_fromDiskInfo :: Lens' InstanceSnapshotInfo (Maybe [DiskInfo]) Source #

A list of objects describing the disks that were attached to the source instance.

InstanceState

instanceState_code :: Lens' InstanceState (Maybe Int) Source #

The status code for the instance.

instanceState_name :: Lens' InstanceState (Maybe Text) Source #

The state of the instance (e.g., running or pending).

KeyPair

keyPair_arn :: Lens' KeyPair (Maybe Text) Source #

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

keyPair_createdAt :: Lens' KeyPair (Maybe UTCTime) Source #

The timestamp when the key pair was created (e.g., 1479816991.349).

keyPair_fingerprint :: Lens' KeyPair (Maybe Text) Source #

The RSA fingerprint of the key pair.

keyPair_location :: Lens' KeyPair (Maybe ResourceLocation) Source #

The region name and Availability Zone where the key pair was created.

keyPair_name :: Lens' KeyPair (Maybe Text) Source #

The friendly name of the SSH key pair.

keyPair_resourceType :: Lens' KeyPair (Maybe ResourceType) Source #

The resource type (usually KeyPair).

keyPair_supportCode :: Lens' KeyPair (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

keyPair_tags :: Lens' KeyPair (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

LightsailDistribution

lightsailDistribution_ableToUpdateBundle :: Lens' LightsailDistribution (Maybe Bool) Source #

Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.

Use the UpdateDistributionBundle action to change your distribution's bundle.

lightsailDistribution_alternativeDomainNames :: Lens' LightsailDistribution (Maybe [Text]) Source #

The alternate domain names of the distribution.

lightsailDistribution_arn :: Lens' LightsailDistribution (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution.

lightsailDistribution_bundleId :: Lens' LightsailDistribution (Maybe Text) Source #

The ID of the bundle currently applied to the distribution.

lightsailDistribution_cacheBehaviorSettings :: Lens' LightsailDistribution (Maybe CacheSettings) Source #

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

lightsailDistribution_cacheBehaviors :: Lens' LightsailDistribution (Maybe [CacheBehaviorPerPath]) Source #

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

lightsailDistribution_certificateName :: Lens' LightsailDistribution (Maybe Text) Source #

The name of the SSL/TLS certificate attached to the distribution, if any.

lightsailDistribution_createdAt :: Lens' LightsailDistribution (Maybe UTCTime) Source #

The timestamp when the distribution was created.

lightsailDistribution_defaultCacheBehavior :: Lens' LightsailDistribution (Maybe CacheBehavior) Source #

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

lightsailDistribution_domainName :: Lens' LightsailDistribution (Maybe Text) Source #

The domain name of the distribution.

lightsailDistribution_ipAddressType :: Lens' LightsailDistribution (Maybe IpAddressType) Source #

The IP address type of the distribution.

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

lightsailDistribution_isEnabled :: Lens' LightsailDistribution (Maybe Bool) Source #

Indicates whether the distribution is enabled.

lightsailDistribution_location :: Lens' LightsailDistribution (Maybe ResourceLocation) Source #

An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.

Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

lightsailDistribution_name :: Lens' LightsailDistribution (Maybe Text) Source #

The name of the distribution.

lightsailDistribution_origin :: Lens' LightsailDistribution (Maybe Origin) Source #

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

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

lightsailDistribution_originPublicDNS :: Lens' LightsailDistribution (Maybe Text) Source #

The public DNS of the origin.

lightsailDistribution_resourceType :: Lens' LightsailDistribution (Maybe ResourceType) Source #

The Lightsail resource type (e.g., Distribution).

lightsailDistribution_status :: Lens' LightsailDistribution (Maybe Text) Source #

The status of the distribution.

lightsailDistribution_supportCode :: Lens' LightsailDistribution (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.

lightsailDistribution_tags :: Lens' LightsailDistribution (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

LoadBalancer

loadBalancer_arn :: Lens' LoadBalancer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the load balancer.

loadBalancer_configurationOptions :: Lens' LoadBalancer (Maybe (HashMap LoadBalancerAttributeName Text)) Source #

A string to string map of the configuration options for your load balancer. Valid values are listed below.

loadBalancer_createdAt :: Lens' LoadBalancer (Maybe UTCTime) Source #

The date when your load balancer was created.

loadBalancer_dnsName :: Lens' LoadBalancer (Maybe Text) Source #

The DNS name of your Lightsail load balancer.

loadBalancer_healthCheckPath :: Lens' LoadBalancer (Maybe Text) Source #

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

loadBalancer_httpsRedirectionEnabled :: Lens' LoadBalancer (Maybe Bool) Source #

A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.

loadBalancer_instanceHealthSummary :: Lens' LoadBalancer (Maybe [InstanceHealthSummary]) Source #

An array of InstanceHealthSummary objects describing the health of the load balancer.

loadBalancer_instancePort :: Lens' LoadBalancer (Maybe Int) Source #

The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

loadBalancer_ipAddressType :: Lens' LoadBalancer (Maybe IpAddressType) Source #

The IP address type of the load balancer.

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

loadBalancer_location :: Lens' LoadBalancer (Maybe ResourceLocation) Source #

The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

loadBalancer_name :: Lens' LoadBalancer (Maybe Text) Source #

The name of the load balancer (e.g., my-load-balancer).

loadBalancer_protocol :: Lens' LoadBalancer (Maybe LoadBalancerProtocol) Source #

The protocol you have enabled for your load balancer. Valid values are below.

You can't just have HTTP_HTTPS, but you can have just HTTP.

loadBalancer_publicPorts :: Lens' LoadBalancer (Maybe [Int]) Source #

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

loadBalancer_resourceType :: Lens' LoadBalancer (Maybe ResourceType) Source #

The resource type (e.g., LoadBalancer.

loadBalancer_state :: Lens' LoadBalancer (Maybe LoadBalancerState) Source #

The status of your load balancer. Valid values are below.

loadBalancer_supportCode :: Lens' LoadBalancer (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

loadBalancer_tags :: Lens' LoadBalancer (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

loadBalancer_tlsCertificateSummaries :: Lens' LoadBalancer (Maybe [LoadBalancerTlsCertificateSummary]) Source #

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

loadBalancer_tlsPolicyName :: Lens' LoadBalancer (Maybe Text) Source #

The name of the TLS security policy for the load balancer.

LoadBalancerTlsCertificate

loadBalancerTlsCertificate_arn :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

loadBalancerTlsCertificate_createdAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #

The time when you created your SSL/TLS certificate.

loadBalancerTlsCertificate_domainName :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The domain name for your SSL/TLS certificate.

loadBalancerTlsCertificate_domainValidationRecords :: Lens' LoadBalancerTlsCertificate (Maybe [LoadBalancerTlsCertificateDomainValidationRecord]) Source #

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

loadBalancerTlsCertificate_failureReason :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateFailureReason) Source #

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.
  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

loadBalancerTlsCertificate_isAttached :: Lens' LoadBalancerTlsCertificate (Maybe Bool) Source #

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

loadBalancerTlsCertificate_issuedAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #

The time when the SSL/TLS certificate was issued.

loadBalancerTlsCertificate_issuer :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The issuer of the certificate.

loadBalancerTlsCertificate_keyAlgorithm :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The algorithm used to generate the key pair (the public and private key).

loadBalancerTlsCertificate_loadBalancerName :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The load balancer name where your SSL/TLS certificate is attached.

loadBalancerTlsCertificate_location :: Lens' LoadBalancerTlsCertificate (Maybe ResourceLocation) Source #

The Amazon Web Services Region and Availability Zone where you created your certificate.

loadBalancerTlsCertificate_name :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The name of the SSL/TLS certificate (e.g., my-certificate).

loadBalancerTlsCertificate_notAfter :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #

The timestamp when the SSL/TLS certificate expires.

loadBalancerTlsCertificate_notBefore :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #

The timestamp when the SSL/TLS certificate is first valid.

loadBalancerTlsCertificate_renewalSummary :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateRenewalSummary) Source #

An object that describes the status of the certificate renewal managed by Lightsail.

loadBalancerTlsCertificate_resourceType :: Lens' LoadBalancerTlsCertificate (Maybe ResourceType) Source #

The resource type (e.g., LoadBalancerTlsCertificate).

  • Instance - A Lightsail instance (a virtual private server)
  • StaticIp - A static IP address
  • KeyPair - The key pair used to connect to a Lightsail instance
  • InstanceSnapshot - A Lightsail instance snapshot
  • Domain - A DNS zone
  • PeeredVpc - A peered VPC
  • LoadBalancer - A Lightsail load balancer
  • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer
  • Disk - A Lightsail block storage disk
  • DiskSnapshot - A block storage disk snapshot

loadBalancerTlsCertificate_revocationReason :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateRevocationReason) Source #

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

loadBalancerTlsCertificate_revokedAt :: Lens' LoadBalancerTlsCertificate (Maybe UTCTime) Source #

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

loadBalancerTlsCertificate_serial :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The serial number of the certificate.

loadBalancerTlsCertificate_signatureAlgorithm :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The algorithm that was used to sign the certificate.

loadBalancerTlsCertificate_status :: Lens' LoadBalancerTlsCertificate (Maybe LoadBalancerTlsCertificateStatus) Source #

The validation status of the SSL/TLS certificate. Valid values are below.

loadBalancerTlsCertificate_subject :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The name of the entity that is associated with the public key contained in the certificate.

loadBalancerTlsCertificate_subjectAlternativeNames :: Lens' LoadBalancerTlsCertificate (Maybe [Text]) Source #

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

loadBalancerTlsCertificate_supportCode :: Lens' LoadBalancerTlsCertificate (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.

loadBalancerTlsCertificate_tags :: Lens' LoadBalancerTlsCertificate (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

LoadBalancerTlsCertificateDnsRecordCreationState

loadBalancerTlsCertificateDnsRecordCreationState_code :: Lens' LoadBalancerTlsCertificateDnsRecordCreationState (Maybe LoadBalancerTlsCertificateDnsRecordCreationStateCode) Source #

The status code for the automated DNS record creation.

Following are the possible values:

  • SUCCEEDED - The validation records were successfully added.
  • STARTED - The automatic DNS record creation has started.
  • FAILED - The validation record addition failed.

loadBalancerTlsCertificateDnsRecordCreationState_message :: Lens' LoadBalancerTlsCertificateDnsRecordCreationState (Maybe Text) Source #

The message that describes the reason for the status code.

LoadBalancerTlsCertificateDomainValidationOption

loadBalancerTlsCertificateDomainValidationOption_domainName :: Lens' LoadBalancerTlsCertificateDomainValidationOption (Maybe Text) Source #

The fully qualified domain name in the certificate request.

loadBalancerTlsCertificateDomainValidationOption_validationStatus :: Lens' LoadBalancerTlsCertificateDomainValidationOption (Maybe LoadBalancerTlsCertificateDomainStatus) Source #

The status of the domain validation. Valid values are listed below.

LoadBalancerTlsCertificateDomainValidationRecord

loadBalancerTlsCertificateDomainValidationRecord_dnsRecordCreationState :: Lens' LoadBalancerTlsCertificateDomainValidationRecord (Maybe LoadBalancerTlsCertificateDnsRecordCreationState) Source #

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of a domain to validate domain ownership.

loadBalancerTlsCertificateDomainValidationRecord_domainName :: Lens' LoadBalancerTlsCertificateDomainValidationRecord (Maybe Text) Source #

The domain name against which your SSL/TLS certificate was validated.

loadBalancerTlsCertificateDomainValidationRecord_name :: Lens' LoadBalancerTlsCertificateDomainValidationRecord (Maybe Text) Source #

A fully qualified domain name in the certificate. For example, example.com.

loadBalancerTlsCertificateDomainValidationRecord_type :: Lens' LoadBalancerTlsCertificateDomainValidationRecord (Maybe Text) Source #

The type of validation record. For example, CNAME for domain validation.

loadBalancerTlsCertificateDomainValidationRecord_validationStatus :: Lens' LoadBalancerTlsCertificateDomainValidationRecord (Maybe LoadBalancerTlsCertificateDomainStatus) Source #

The validation status. Valid values are listed below.

loadBalancerTlsCertificateDomainValidationRecord_value :: Lens' LoadBalancerTlsCertificateDomainValidationRecord (Maybe Text) Source #

The value for that type.

LoadBalancerTlsCertificateRenewalSummary

loadBalancerTlsCertificateRenewalSummary_domainValidationOptions :: Lens' LoadBalancerTlsCertificateRenewalSummary (Maybe [LoadBalancerTlsCertificateDomainValidationOption]) Source #

Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.

loadBalancerTlsCertificateRenewalSummary_renewalStatus :: Lens' LoadBalancerTlsCertificateRenewalSummary (Maybe LoadBalancerTlsCertificateRenewalStatus) Source #

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.
  • PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.
  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.
  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

LoadBalancerTlsCertificateSummary

loadBalancerTlsCertificateSummary_isAttached :: Lens' LoadBalancerTlsCertificateSummary (Maybe Bool) Source #

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

loadBalancerTlsCertificateSummary_name :: Lens' LoadBalancerTlsCertificateSummary (Maybe Text) Source #

The name of the SSL/TLS certificate.

LoadBalancerTlsPolicy

loadBalancerTlsPolicy_ciphers :: Lens' LoadBalancerTlsPolicy (Maybe [Text]) Source #

The ciphers used by the TLS security policy.

The ciphers are listed in order of preference.

loadBalancerTlsPolicy_description :: Lens' LoadBalancerTlsPolicy (Maybe Text) Source #

The description of the TLS security policy.

loadBalancerTlsPolicy_isDefault :: Lens' LoadBalancerTlsPolicy (Maybe Bool) Source #

A Boolean value that indicates whether the TLS security policy is the default.

loadBalancerTlsPolicy_name :: Lens' LoadBalancerTlsPolicy (Maybe Text) Source #

The name of the TLS security policy.

loadBalancerTlsPolicy_protocols :: Lens' LoadBalancerTlsPolicy (Maybe [Text]) Source #

The protocols used in a given TLS security policy.

LogEvent

logEvent_createdAt :: Lens' LogEvent (Maybe UTCTime) Source #

The timestamp when the database log event was created.

logEvent_message :: Lens' LogEvent (Maybe Text) Source #

The message of the database log event.

MetricDatapoint

metricDatapoint_average :: Lens' MetricDatapoint (Maybe Double) Source #

The average.

metricDatapoint_maximum :: Lens' MetricDatapoint (Maybe Double) Source #

The maximum.

metricDatapoint_minimum :: Lens' MetricDatapoint (Maybe Double) Source #

The minimum.

metricDatapoint_sampleCount :: Lens' MetricDatapoint (Maybe Double) Source #

The sample count.

metricDatapoint_sum :: Lens' MetricDatapoint (Maybe Double) Source #

The sum.

metricDatapoint_timestamp :: Lens' MetricDatapoint (Maybe UTCTime) Source #

The timestamp (e.g., 1479816991.349).

metricDatapoint_unit :: Lens' MetricDatapoint (Maybe MetricUnit) Source #

The unit.

MonitoredResourceInfo

monitoredResourceInfo_arn :: Lens' MonitoredResourceInfo (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource being monitored.

monitoredResourceInfo_name :: Lens' MonitoredResourceInfo (Maybe Text) Source #

The name of the Lightsail resource being monitored.

monitoredResourceInfo_resourceType :: Lens' MonitoredResourceInfo (Maybe ResourceType) Source #

The Lightsail resource type of the resource being monitored.

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

MonthlyTransfer

monthlyTransfer_gbPerMonthAllocated :: Lens' MonthlyTransfer (Maybe Int) Source #

The amount allocated per month (in GB).

NameServersUpdateState

nameServersUpdateState_code :: Lens' NameServersUpdateState (Maybe NameServersUpdateStateCode) Source #

The status code for the name servers update.

Following are the possible values:

  • SUCCEEDED - The name server records were successfully updated.
  • PENDING - The name server record update is in progress.
  • FAILED - The name server record update failed.
  • STARTED - The automatic name server record update started.

nameServersUpdateState_message :: Lens' NameServersUpdateState (Maybe Text) Source #

The message that describes the reason for the status code.

Operation

operation_createdAt :: Lens' Operation (Maybe UTCTime) Source #

The timestamp when the operation was initialized (e.g., 1479816991.349).

operation_errorCode :: Lens' Operation (Maybe Text) Source #

The error code.

operation_errorDetails :: Lens' Operation (Maybe Text) Source #

The error details.

operation_id :: Lens' Operation (Maybe Text) Source #

The ID of the operation.

operation_isTerminal :: Lens' Operation (Maybe Bool) Source #

A Boolean value indicating whether the operation is terminal.

operation_location :: Lens' Operation (Maybe ResourceLocation) Source #

The Amazon Web Services Region and Availability Zone.

operation_operationDetails :: Lens' Operation (Maybe Text) Source #

Details about the operation (e.g., Debian-1GB-Ohio-1).

operation_operationType :: Lens' Operation (Maybe OperationType) Source #

The type of operation.

operation_resourceName :: Lens' Operation (Maybe Text) Source #

The resource name.

operation_resourceType :: Lens' Operation (Maybe ResourceType) Source #

The resource type.

operation_status :: Lens' Operation (Maybe OperationStatus) Source #

The status of the operation.

operation_statusChangedAt :: Lens' Operation (Maybe UTCTime) Source #

The timestamp when the status was changed (e.g., 1479816991.349).

Origin

origin_name :: Lens' Origin (Maybe Text) Source #

The name of the origin resource.

origin_protocolPolicy :: Lens' Origin (Maybe OriginProtocolPolicyEnum) Source #

The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

origin_regionName :: Lens' Origin (Maybe RegionName) Source #

The AWS Region name of the origin resource.

origin_resourceType :: Lens' Origin (Maybe ResourceType) Source #

The resource type of the origin resource (e.g., Instance).

PasswordData

passwordData_ciphertext :: Lens' PasswordData (Maybe Text) Source #

The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field.

If you are using a custom key pair, you need to use your own means of decryption.

If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

passwordData_keyPairName :: Lens' PasswordData (Maybe Text) Source #

The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).

If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.

PendingMaintenanceAction

pendingMaintenanceAction_action :: Lens' PendingMaintenanceAction (Maybe Text) Source #

The type of pending database maintenance action.

pendingMaintenanceAction_currentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #

The effective date of the pending database maintenance action.

pendingMaintenanceAction_description :: Lens' PendingMaintenanceAction (Maybe Text) Source #

Additional detail about the pending database maintenance action.

PendingModifiedRelationalDatabaseValues

pendingModifiedRelationalDatabaseValues_backupRetentionEnabled :: Lens' PendingModifiedRelationalDatabaseValues (Maybe Bool) Source #

A Boolean value indicating whether automated backup retention is enabled.

pendingModifiedRelationalDatabaseValues_engineVersion :: Lens' PendingModifiedRelationalDatabaseValues (Maybe Text) Source #

The database engine version.

pendingModifiedRelationalDatabaseValues_masterUserPassword :: Lens' PendingModifiedRelationalDatabaseValues (Maybe Text) Source #

The password for the master user of the database.

PortInfo

portInfo_cidrListAliases :: Lens' PortInfo (Maybe [Text]) Source #

An alias that defines access for a preconfigured range of IP addresses.

The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.

portInfo_cidrs :: Lens' PortInfo (Maybe [Text]) Source #

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.

Examples:

  • To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.
  • To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

portInfo_fromPort :: Lens' PortInfo (Maybe Int) Source #

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535
  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

portInfo_ipv6Cidrs :: Lens' PortInfo (Maybe [Text]) Source #

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.

The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

portInfo_protocol :: Lens' PortInfo (Maybe NetworkProtocol) Source #

The IP protocol name.

The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

portInfo_toPort :: Lens' PortInfo (Maybe Int) Source #

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535
  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

PrivateRegistryAccess

privateRegistryAccess_ecrImagePullerRole :: Lens' PrivateRegistryAccess (Maybe ContainerServiceECRImagePullerRole) Source #

An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed.

PrivateRegistryAccessRequest

privateRegistryAccessRequest_ecrImagePullerRole :: Lens' PrivateRegistryAccessRequest (Maybe ContainerServiceECRImagePullerRoleRequest) Source #

An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

QueryStringObject

queryStringObject_option :: Lens' QueryStringObject (Maybe Bool) Source #

Indicates whether the distribution forwards and caches based on query strings.

queryStringObject_queryStringsAllowList :: Lens' QueryStringObject (Maybe [Text]) Source #

The specific query strings that the distribution forwards to the origin.

Your distribution will cache content based on the specified query strings.

If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.

R53HostedZoneDeletionState

r53HostedZoneDeletionState_code :: Lens' R53HostedZoneDeletionState (Maybe R53HostedZoneDeletionStateCode) Source #

The status code for the deletion state.

Following are the possible values:

  • SUCCEEDED - The hosted zone was successfully deleted.
  • PENDING - The hosted zone deletion is in progress.
  • FAILED - The hosted zone deletion failed.
  • STARTED - The hosted zone deletion started.

r53HostedZoneDeletionState_message :: Lens' R53HostedZoneDeletionState (Maybe Text) Source #

The message that describes the reason for the status code.

RegionInfo

regionInfo_availabilityZones :: Lens' RegionInfo (Maybe [AvailabilityZone]) Source #

The Availability Zones. Follows the format us-east-2a (case-sensitive).

regionInfo_continentCode :: Lens' RegionInfo (Maybe Text) Source #

The continent code (e.g., NA, meaning North America).

regionInfo_description :: Lens' RegionInfo (Maybe Text) Source #

The description of the Amazon Web Services Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).

regionInfo_displayName :: Lens' RegionInfo (Maybe Text) Source #

The display name (e.g., Ohio).

regionInfo_name :: Lens' RegionInfo (Maybe RegionName) Source #

The region name (e.g., us-east-2).

regionInfo_relationalDatabaseAvailabilityZones :: Lens' RegionInfo (Maybe [AvailabilityZone]) Source #

The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).

RegisteredDomainDelegationInfo

registeredDomainDelegationInfo_nameServersUpdateState :: Lens' RegisteredDomainDelegationInfo (Maybe NameServersUpdateState) Source #

An object that describes the state of the name server records that are automatically added to the Route 53 domain by Lightsail.

registeredDomainDelegationInfo_r53HostedZoneDeletionState :: Lens' RegisteredDomainDelegationInfo (Maybe R53HostedZoneDeletionState) Source #

Undocumented member.

RelationalDatabase

relationalDatabase_arn :: Lens' RelationalDatabase (Maybe Text) Source #

The Amazon Resource Name (ARN) of the database.

relationalDatabase_backupRetentionEnabled :: Lens' RelationalDatabase (Maybe Bool) Source #

A Boolean value indicating whether automated backup retention is enabled for the database.

relationalDatabase_caCertificateIdentifier :: Lens' RelationalDatabase (Maybe Text) Source #

The certificate associated with the database.

relationalDatabase_createdAt :: Lens' RelationalDatabase (Maybe UTCTime) Source #

The timestamp when the database was created. Formatted in Unix time.

relationalDatabase_engine :: Lens' RelationalDatabase (Maybe Text) Source #

The database software (for example, MySQL).

relationalDatabase_engineVersion :: Lens' RelationalDatabase (Maybe Text) Source #

The database engine version (for example, 5.7.23).

relationalDatabase_hardware :: Lens' RelationalDatabase (Maybe RelationalDatabaseHardware) Source #

Describes the hardware of the database.

relationalDatabase_latestRestorableTime :: Lens' RelationalDatabase (Maybe UTCTime) Source #

The latest point in time to which the database can be restored. Formatted in Unix time.

relationalDatabase_location :: Lens' RelationalDatabase (Maybe ResourceLocation) Source #

The Region name and Availability Zone where the database is located.

relationalDatabase_masterDatabaseName :: Lens' RelationalDatabase (Maybe Text) Source #

The name of the master database created when the Lightsail database resource is created.

relationalDatabase_masterEndpoint :: Lens' RelationalDatabase (Maybe RelationalDatabaseEndpoint) Source #

The master endpoint for the database.

relationalDatabase_masterUsername :: Lens' RelationalDatabase (Maybe Text) Source #

The master user name of the database.

relationalDatabase_name :: Lens' RelationalDatabase (Maybe Text) Source #

The unique name of the database resource in Lightsail.

relationalDatabase_parameterApplyStatus :: Lens' RelationalDatabase (Maybe Text) Source #

The status of parameter updates for the database.

relationalDatabase_pendingMaintenanceActions :: Lens' RelationalDatabase (Maybe [PendingMaintenanceAction]) Source #

Describes the pending maintenance actions for the database.

relationalDatabase_pendingModifiedValues :: Lens' RelationalDatabase (Maybe PendingModifiedRelationalDatabaseValues) Source #

Describes pending database value modifications.

relationalDatabase_preferredBackupWindow :: Lens' RelationalDatabase (Maybe Text) Source #

The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

relationalDatabase_preferredMaintenanceWindow :: Lens' RelationalDatabase (Maybe Text) Source #

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

In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

relationalDatabase_publiclyAccessible :: Lens' RelationalDatabase (Maybe Bool) Source #

A Boolean value indicating whether the database is publicly accessible.

relationalDatabase_relationalDatabaseBlueprintId :: Lens' RelationalDatabase (Maybe Text) Source #

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

relationalDatabase_relationalDatabaseBundleId :: Lens' RelationalDatabase (Maybe Text) Source #

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

relationalDatabase_resourceType :: Lens' RelationalDatabase (Maybe ResourceType) Source #

The Lightsail resource type for the database (for example, RelationalDatabase).

relationalDatabase_secondaryAvailabilityZone :: Lens' RelationalDatabase (Maybe Text) Source #

Describes the secondary Availability Zone of a high availability database.

The secondary database is used for failover support of a high availability database.

relationalDatabase_state :: Lens' RelationalDatabase (Maybe Text) Source #

Describes the current state of the database.

relationalDatabase_supportCode :: Lens' RelationalDatabase (Maybe Text) Source #

The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

relationalDatabase_tags :: Lens' RelationalDatabase (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

RelationalDatabaseBlueprint

relationalDatabaseBlueprint_blueprintId :: Lens' RelationalDatabaseBlueprint (Maybe Text) Source #

The ID for the database blueprint.

relationalDatabaseBlueprint_engine :: Lens' RelationalDatabaseBlueprint (Maybe RelationalDatabaseEngine) Source #

The database software of the database blueprint (for example, MySQL).

relationalDatabaseBlueprint_engineDescription :: Lens' RelationalDatabaseBlueprint (Maybe Text) Source #

The description of the database engine for the database blueprint.

relationalDatabaseBlueprint_engineVersion :: Lens' RelationalDatabaseBlueprint (Maybe Text) Source #

The database engine version for the database blueprint (for example, 5.7.23).

relationalDatabaseBlueprint_engineVersionDescription :: Lens' RelationalDatabaseBlueprint (Maybe Text) Source #

The description of the database engine version for the database blueprint.

relationalDatabaseBlueprint_isEngineDefault :: Lens' RelationalDatabaseBlueprint (Maybe Bool) Source #

A Boolean value indicating whether the engine version is the default for the database blueprint.

RelationalDatabaseBundle

relationalDatabaseBundle_bundleId :: Lens' RelationalDatabaseBundle (Maybe Text) Source #

The ID for the database bundle.

relationalDatabaseBundle_cpuCount :: Lens' RelationalDatabaseBundle (Maybe Int) Source #

The number of virtual CPUs (vCPUs) for the database bundle.

relationalDatabaseBundle_diskSizeInGb :: Lens' RelationalDatabaseBundle (Maybe Int) Source #

The size of the disk for the database bundle.

relationalDatabaseBundle_isActive :: Lens' RelationalDatabaseBundle (Maybe Bool) Source #

A Boolean value indicating whether the database bundle is active.

relationalDatabaseBundle_isEncrypted :: Lens' RelationalDatabaseBundle (Maybe Bool) Source #

A Boolean value indicating whether the database bundle is encrypted.

relationalDatabaseBundle_name :: Lens' RelationalDatabaseBundle (Maybe Text) Source #

The name for the database bundle.

relationalDatabaseBundle_price :: Lens' RelationalDatabaseBundle (Maybe Double) Source #

The cost of the database bundle in US currency.

relationalDatabaseBundle_ramSizeInGb :: Lens' RelationalDatabaseBundle (Maybe Double) Source #

The amount of RAM in GB (for example, 2.0) for the database bundle.

relationalDatabaseBundle_transferPerMonthInGb :: Lens' RelationalDatabaseBundle (Maybe Int) Source #

The data transfer rate per month in GB for the database bundle.

RelationalDatabaseEndpoint

relationalDatabaseEndpoint_address :: Lens' RelationalDatabaseEndpoint (Maybe Text) Source #

Specifies the DNS address of the database.

relationalDatabaseEndpoint_port :: Lens' RelationalDatabaseEndpoint (Maybe Int) Source #

Specifies the port that the database is listening on.

RelationalDatabaseEvent

relationalDatabaseEvent_createdAt :: Lens' RelationalDatabaseEvent (Maybe UTCTime) Source #

The timestamp when the database event was created.

relationalDatabaseEvent_eventCategories :: Lens' RelationalDatabaseEvent (Maybe [Text]) Source #

The category that the database event belongs to.

relationalDatabaseEvent_message :: Lens' RelationalDatabaseEvent (Maybe Text) Source #

The message of the database event.

relationalDatabaseEvent_resource :: Lens' RelationalDatabaseEvent (Maybe Text) Source #

The database that the database event relates to.

RelationalDatabaseHardware

relationalDatabaseHardware_cpuCount :: Lens' RelationalDatabaseHardware (Maybe Int) Source #

The number of vCPUs for the database.

relationalDatabaseHardware_diskSizeInGb :: Lens' RelationalDatabaseHardware (Maybe Int) Source #

The size of the disk for the database.

relationalDatabaseHardware_ramSizeInGb :: Lens' RelationalDatabaseHardware (Maybe Double) Source #

The amount of RAM in GB for the database.

RelationalDatabaseParameter

relationalDatabaseParameter_allowedValues :: Lens' RelationalDatabaseParameter (Maybe Text) Source #

Specifies the valid range of values for the parameter.

relationalDatabaseParameter_applyMethod :: Lens' RelationalDatabaseParameter (Maybe Text) Source #

Indicates when parameter updates are applied.

Can be immediate or pending-reboot.

relationalDatabaseParameter_applyType :: Lens' RelationalDatabaseParameter (Maybe Text) Source #

Specifies the engine-specific parameter type.

relationalDatabaseParameter_dataType :: Lens' RelationalDatabaseParameter (Maybe Text) Source #

Specifies the valid data type for the parameter.

relationalDatabaseParameter_description :: Lens' RelationalDatabaseParameter (Maybe Text) Source #

Provides a description of the parameter.

relationalDatabaseParameter_isModifiable :: Lens' RelationalDatabaseParameter (Maybe Bool) Source #

A Boolean value indicating whether the parameter can be modified.

relationalDatabaseParameter_parameterName :: Lens' RelationalDatabaseParameter (Maybe Text) Source #

Specifies the name of the parameter.

relationalDatabaseParameter_parameterValue :: Lens' RelationalDatabaseParameter (Maybe Text) Source #

Specifies the value of the parameter.

RelationalDatabaseSnapshot

relationalDatabaseSnapshot_arn :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the database snapshot.

relationalDatabaseSnapshot_createdAt :: Lens' RelationalDatabaseSnapshot (Maybe UTCTime) Source #

The timestamp when the database snapshot was created.

relationalDatabaseSnapshot_engine :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The software of the database snapshot (for example, MySQL)

relationalDatabaseSnapshot_engineVersion :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The database engine version for the database snapshot (for example, 5.7.23).

relationalDatabaseSnapshot_fromRelationalDatabaseArn :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the database from which the database snapshot was created.

relationalDatabaseSnapshot_fromRelationalDatabaseBlueprintId :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.

relationalDatabaseSnapshot_fromRelationalDatabaseBundleId :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The bundle ID of the database from which the database snapshot was created.

relationalDatabaseSnapshot_fromRelationalDatabaseName :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The name of the source database from which the database snapshot was created.

relationalDatabaseSnapshot_location :: Lens' RelationalDatabaseSnapshot (Maybe ResourceLocation) Source #

The Region name and Availability Zone where the database snapshot is located.

relationalDatabaseSnapshot_name :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The name of the database snapshot.

relationalDatabaseSnapshot_resourceType :: Lens' RelationalDatabaseSnapshot (Maybe ResourceType) Source #

The Lightsail resource type.

relationalDatabaseSnapshot_sizeInGb :: Lens' RelationalDatabaseSnapshot (Maybe Int) Source #

The size of the disk in GB (for example, 32) for the database snapshot.

relationalDatabaseSnapshot_state :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The state of the database snapshot.

relationalDatabaseSnapshot_supportCode :: Lens' RelationalDatabaseSnapshot (Maybe Text) Source #

The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.

relationalDatabaseSnapshot_tags :: Lens' RelationalDatabaseSnapshot (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

RenewalSummary

renewalSummary_domainValidationRecords :: Lens' RenewalSummary (Maybe [DomainValidationRecord]) Source #

An array of objects that describe the domain validation records of the certificate.

renewalSummary_renewalStatus :: Lens' RenewalSummary (Maybe RenewalStatus) Source #

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required.
  • PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.
  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.
  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

renewalSummary_renewalStatusReason :: Lens' RenewalSummary (Maybe Text) Source #

The reason for the renewal status of the certificate.

renewalSummary_updatedAt :: Lens' RenewalSummary (Maybe UTCTime) Source #

The timestamp when the certificate was last updated.

ResourceLocation

resourceLocation_availabilityZone :: Lens' ResourceLocation (Maybe Text) Source #

The Availability Zone. Follows the format us-east-2a (case-sensitive).

resourceLocation_regionName :: Lens' ResourceLocation (Maybe RegionName) Source #

The Amazon Web Services Region name.

ResourceReceivingAccess

resourceReceivingAccess_name :: Lens' ResourceReceivingAccess (Maybe Text) Source #

The name of the Lightsail instance.

resourceReceivingAccess_resourceType :: Lens' ResourceReceivingAccess (Maybe Text) Source #

The Lightsail resource type (for example, Instance).

ResourceRecord

resourceRecord_name :: Lens' ResourceRecord (Maybe Text) Source #

The name of the record.

resourceRecord_type :: Lens' ResourceRecord (Maybe Text) Source #

The DNS record type.

resourceRecord_value :: Lens' ResourceRecord (Maybe Text) Source #

The value for the DNS record.

StaticIp

staticIp_arn :: Lens' StaticIp (Maybe Text) Source #

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

staticIp_attachedTo :: Lens' StaticIp (Maybe Text) Source #

The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).

staticIp_createdAt :: Lens' StaticIp (Maybe UTCTime) Source #

The timestamp when the static IP was created (e.g., 1479735304.222).

staticIp_ipAddress :: Lens' StaticIp (Maybe Text) Source #

The static IP address.

staticIp_isAttached :: Lens' StaticIp (Maybe Bool) Source #

A Boolean value indicating whether the static IP is attached.

staticIp_location :: Lens' StaticIp (Maybe ResourceLocation) Source #

The region and Availability Zone where the static IP was created.

staticIp_name :: Lens' StaticIp (Maybe Text) Source #

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

staticIp_resourceType :: Lens' StaticIp (Maybe ResourceType) Source #

The resource type (usually StaticIp).

staticIp_supportCode :: Lens' StaticIp (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Tag

tag_key :: Lens' Tag (Maybe Text) Source #

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

tag_value :: Lens' Tag (Maybe Text) Source #

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @