lightsail

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 18, 2021 License: Apache-2.0 Imports: 27 Imported by: 50

Documentation

Overview

Package lightsail provides the API client, operations, and parameter types for Amazon Lightsail.

Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price. You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide (http://lightsail.aws.amazon.com/ls/docs/how-to/article/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli). This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported AWS Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the AWS General Reference.

Index

Constants

View Source 
const ServiceAPIVersion = "2016-11-28"
View Source 
const ServiceID = "Lightsail"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AllocateStaticIpInput 

type AllocateStaticIpInput struct {

	// The name of the static IP address.
	//
	// This member is required.
	StaticIpName *string
}

type AllocateStaticIpOutput 

type AllocateStaticIpOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachCertificateToDistributionInput 

type AttachCertificateToDistributionInput struct {

	// 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.
	//
	// This member is required.
	CertificateName *string

	// 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.
	//
	// This member is required.
	DistributionName *string
}

type AttachCertificateToDistributionOutput 

type AttachCertificateToDistributionOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachDiskInput 

type AttachDiskInput struct {

	// The unique Lightsail disk name (e.g., my-disk).
	//
	// This member is required.
	DiskName *string

	// The disk path to expose to the instance (e.g., /dev/xvdf).
	//
	// This member is required.
	DiskPath *string

	// The name of the Lightsail instance where you want to utilize the storage disk.
	//
	// This member is required.
	InstanceName *string
}

type AttachDiskOutput 

type AttachDiskOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachInstancesToLoadBalancerInput 

type AttachInstancesToLoadBalancerInput struct {

	// 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).
	//
	// This member is required.
	InstanceNames []string

	// The name of the load balancer.
	//
	// This member is required.
	LoadBalancerName *string
}

type AttachInstancesToLoadBalancerOutput 

type AttachInstancesToLoadBalancerOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachLoadBalancerTlsCertificateInput 

type AttachLoadBalancerTlsCertificateInput struct {

	// The name of your SSL/TLS certificate.
	//
	// This member is required.
	CertificateName *string

	// The name of the load balancer to which you want to associate the SSL/TLS
	// certificate.
	//
	// This member is required.
	LoadBalancerName *string
}

type AttachLoadBalancerTlsCertificateOutput 

type AttachLoadBalancerTlsCertificateOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachStaticIpInput 

type AttachStaticIpInput struct {

	// The instance name to which you want to attach the static IP address.
	//
	// This member is required.
	InstanceName *string

	// The name of the static IP.
	//
	// This member is required.
	StaticIpName *string
}

type AttachStaticIpOutput 

type AttachStaticIpOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Lightsail.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AllocateStaticIp 

func (c *Client) AllocateStaticIp(ctx context.Context, params *AllocateStaticIpInput, optFns ...func(*Options)) (*AllocateStaticIpOutput, error)

Allocates a static IP address.

func (*Client) AttachCertificateToDistribution 

func (c *Client) AttachCertificateToDistribution(ctx context.Context, params *AttachCertificateToDistributionInput, optFns ...func(*Options)) (*AttachCertificateToDistributionOutput, error)

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate. Use the CreateCertificate action to create a certificate that you can attach to your distribution. Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

func (*Client) AttachDisk 

func (c *Client) AttachDisk(ctx context.Context, params *AttachDiskInput, optFns ...func(*Options)) (*AttachDiskOutput, error)

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name. The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) AttachInstancesToLoadBalancer 

func (c *Client) AttachInstancesToLoadBalancer(ctx context.Context, params *AttachInstancesToLoadBalancerInput, optFns ...func(*Options)) (*AttachInstancesToLoadBalancerOutput, error)

Attaches one or more Lightsail instances to a load balancer. After some time, the instances are attached to the load balancer and the health check status is available. The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) AttachLoadBalancerTlsCertificate 

func (c *Client) AttachLoadBalancerTlsCertificate(ctx context.Context, params *AttachLoadBalancerTlsCertificateInput, optFns ...func(*Options)) (*AttachLoadBalancerTlsCertificateOutput, error)

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) AttachStaticIp 

func (c *Client) AttachStaticIp(ctx context.Context, params *AttachStaticIpInput, optFns ...func(*Options)) (*AttachStaticIpOutput, error)

Attaches a static IP address to a specific Amazon Lightsail instance.

func (*Client) CloseInstancePublicPorts 

func (c *Client) CloseInstancePublicPorts(ctx context.Context, params *CloseInstancePublicPortsInput, optFns ...func(*Options)) (*CloseInstancePublicPortsOutput, error)

Closes ports for a specific Amazon Lightsail instance. The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CopySnapshot 

func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, optFns ...func(*Options)) (*CopySnapshotOutput, error)

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail. When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters. When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

func (*Client) CreateCertificate 

func (c *Client) CreateCertificate(ctx context.Context, params *CreateCertificateInput, optFns ...func(*Options)) (*CreateCertificateOutput, error)

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service. After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service. Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

func (*Client) CreateCloudFormationStack 

func (c *Client) CreateCloudFormationStack(ctx context.Context, params *CreateCloudFormationStackInput, optFns ...func(*Options)) (*CreateCloudFormationStackOutput, error)

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.

func (*Client) CreateContactMethod 

func (c *Client) CreateContactMethod(ctx context.Context, params *CreateContactMethodInput, optFns ...func(*Options)) (*CreateContactMethodOutput, error)

Creates an email or SMS text message contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).

func (*Client) CreateContainerService added in v0.30.0 

func (c *Client) CreateContainerService(ctx context.Context, params *CreateContainerServiceInput, optFns ...func(*Options)) (*CreateContainerServiceOutput, error)

Creates an Amazon Lightsail container service. A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-services) in the Lightsail Dev Guide.

func (*Client) CreateContainerServiceDeployment added in v0.30.0 

func (c *Client) CreateContainerServiceDeployment(ctx context.Context, params *CreateContainerServiceDeploymentInput, optFns ...func(*Options)) (*CreateContainerServiceDeploymentOutput, error)

Creates a deployment for your Amazon Lightsail container service. A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration. You can deploy containers to your container service using container images from a public registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images) in the Lightsail Dev Guide.

func (*Client) CreateContainerServiceRegistryLogin added in v0.30.0 

func (c *Client) CreateContainerServiceRegistryLogin(ctx context.Context, params *CreateContainerServiceRegistryLoginInput, optFns ...func(*Options)) (*CreateContainerServiceRegistryLoginOutput, error)

Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials. You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry. After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service. This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images) in the Lightsail Dev Guide.

func (*Client) CreateDisk 

func (c *Client) CreateDisk(ctx context.Context, params *CreateDiskInput, optFns ...func(*Options)) (*CreateDiskOutput, error)

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateDiskFromSnapshot 

func (c *Client) CreateDiskFromSnapshot(ctx context.Context, params *CreateDiskFromSnapshotInput, optFns ...func(*Options)) (*CreateDiskFromSnapshotOutput, error)

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateDiskSnapshot 

func (c *Client) CreateDiskSnapshot(ctx context.Context, params *CreateDiskSnapshotInput, optFns ...func(*Options)) (*CreateDiskSnapshotOutput, error)

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending. You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk. The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateDistribution 

func (c *Client) CreateDistribution(ctx context.Context, params *CreateDistributionInput, optFns ...func(*Options)) (*CreateDistributionOutput, error)

Creates an Amazon Lightsail content delivery network (CDN) distribution. A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-content-delivery-network-distributions).

func (*Client) CreateDomain 

func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error)

Creates a domain resource for the specified domain (e.g., example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateDomainEntry 

func (c *Client) CreateDomainEntry(ctx context.Context, params *CreateDomainEntryInput, optFns ...func(*Options)) (*CreateDomainEntryOutput, error)

Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateInstanceSnapshot 

func (c *Client) CreateInstanceSnapshot(ctx context.Context, params *CreateInstanceSnapshotInput, optFns ...func(*Options)) (*CreateInstanceSnapshotOutput, error)

Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot. The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateInstances 

func (c *Client) CreateInstances(ctx context.Context, params *CreateInstancesInput, optFns ...func(*Options)) (*CreateInstancesOutput, error)

Creates one or more Amazon Lightsail instances. The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateInstancesFromSnapshot 

func (c *Client) CreateInstancesFromSnapshot(ctx context.Context, params *CreateInstancesFromSnapshotInput, optFns ...func(*Options)) (*CreateInstancesFromSnapshotOutput, error)

Creates one or more new instances from a manual or automatic snapshot of an instance. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateKeyPair 

func (c *Client) CreateKeyPair(ctx context.Context, params *CreateKeyPairInput, optFns ...func(*Options)) (*CreateKeyPairOutput, error)

Creates an SSH key pair. The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateLoadBalancer 

func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalancerInput, optFns ...func(*Options)) (*CreateLoadBalancerOutput, error)

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing (https://lightsail.aws.amazon.com/ls/docs/how-to/article/configure-lightsail-instances-for-load-balancing). You can create up to 5 load balancers per AWS Region in your account. When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation. The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateLoadBalancerTlsCertificate 

func (c *Client) CreateLoadBalancerTlsCertificate(ctx context.Context, params *CreateLoadBalancerTlsCertificateInput, optFns ...func(*Options)) (*CreateLoadBalancerTlsCertificateOutput, error)

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateRelationalDatabase 

func (c *Client) CreateRelationalDatabase(ctx context.Context, params *CreateRelationalDatabaseInput, optFns ...func(*Options)) (*CreateRelationalDatabaseOutput, error)

Creates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateRelationalDatabaseFromSnapshot 

func (c *Client) CreateRelationalDatabaseFromSnapshot(ctx context.Context, params *CreateRelationalDatabaseFromSnapshotInput, optFns ...func(*Options)) (*CreateRelationalDatabaseFromSnapshotOutput, error)

Creates a new database from an existing database snapshot in Amazon Lightsail. You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan. The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) CreateRelationalDatabaseSnapshot 

func (c *Client) CreateRelationalDatabaseSnapshot(ctx context.Context, params *CreateRelationalDatabaseSnapshotInput, optFns ...func(*Options)) (*CreateRelationalDatabaseSnapshotOutput, error)

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteAlarm 

func (c *Client) DeleteAlarm(ctx context.Context, params *DeleteAlarmInput, optFns ...func(*Options)) (*DeleteAlarmOutput, error)

Deletes an alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

func (*Client) DeleteAutoSnapshot 

func (c *Client) DeleteAutoSnapshot(ctx context.Context, params *DeleteAutoSnapshotInput, optFns ...func(*Options)) (*DeleteAutoSnapshotOutput, error)

Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).

func (*Client) DeleteCertificate 

func (c *Client) DeleteCertificate(ctx context.Context, params *DeleteCertificateInput, optFns ...func(*Options)) (*DeleteCertificateOutput, error)

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution. Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.

func (*Client) DeleteContactMethod 

func (c *Client) DeleteContactMethod(ctx context.Context, params *DeleteContactMethodInput, optFns ...func(*Options)) (*DeleteContactMethodOutput, error)

Deletes a contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).

func (*Client) DeleteContainerImage added in v0.30.0 

func (c *Client) DeleteContainerImage(ctx context.Context, params *DeleteContainerImageInput, optFns ...func(*Options)) (*DeleteContainerImageOutput, error)

Deletes a container image that is registered to your Amazon Lightsail container service.

func (*Client) DeleteContainerService added in v0.30.0 

func (c *Client) DeleteContainerService(ctx context.Context, params *DeleteContainerServiceInput, optFns ...func(*Options)) (*DeleteContainerServiceOutput, error)

Deletes your Amazon Lightsail container service.

func (*Client) DeleteDisk 

func (c *Client) DeleteDisk(ctx context.Context, params *DeleteDiskInput, optFns ...func(*Options)) (*DeleteDiskOutput, error)

Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteDiskSnapshot 

func (c *Client) DeleteDiskSnapshot(ctx context.Context, params *DeleteDiskSnapshotInput, optFns ...func(*Options)) (*DeleteDiskSnapshotOutput, error)

Deletes the specified disk snapshot. When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk. The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteDistribution 

func (c *Client) DeleteDistribution(ctx context.Context, params *DeleteDistributionInput, optFns ...func(*Options)) (*DeleteDistributionOutput, error)

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

func (*Client) DeleteDomain 

func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error)

Deletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteDomainEntry 

func (c *Client) DeleteDomainEntry(ctx context.Context, params *DeleteDomainEntryInput, optFns ...func(*Options)) (*DeleteDomainEntryOutput, error)

Deletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteInstance 

func (c *Client) DeleteInstance(ctx context.Context, params *DeleteInstanceInput, optFns ...func(*Options)) (*DeleteInstanceOutput, error)

Deletes an Amazon Lightsail instance. The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteInstanceSnapshot 

func (c *Client) DeleteInstanceSnapshot(ctx context.Context, params *DeleteInstanceSnapshotInput, optFns ...func(*Options)) (*DeleteInstanceSnapshotOutput, error)

Deletes a specific snapshot of a virtual private server (or instance). The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteKeyPair 

func (c *Client) DeleteKeyPair(ctx context.Context, params *DeleteKeyPairInput, optFns ...func(*Options)) (*DeleteKeyPairOutput, error)

Deletes a specific SSH key pair. The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteKnownHostKeys 

func (c *Client) DeleteKnownHostKeys(ctx context.Context, params *DeleteKnownHostKeysInput, optFns ...func(*Options)) (*DeleteKnownHostKeysOutput, error)

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch. Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection).

func (*Client) DeleteLoadBalancer 

func (c *Client) DeleteLoadBalancer(ctx context.Context, params *DeleteLoadBalancerInput, optFns ...func(*Options)) (*DeleteLoadBalancerOutput, error)

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again. The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteLoadBalancerTlsCertificate 

func (c *Client) DeleteLoadBalancerTlsCertificate(ctx context.Context, params *DeleteLoadBalancerTlsCertificateInput, optFns ...func(*Options)) (*DeleteLoadBalancerTlsCertificateOutput, error)

Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteRelationalDatabase 

func (c *Client) DeleteRelationalDatabase(ctx context.Context, params *DeleteRelationalDatabaseInput, optFns ...func(*Options)) (*DeleteRelationalDatabaseOutput, error)

Deletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DeleteRelationalDatabaseSnapshot 

func (c *Client) DeleteRelationalDatabaseSnapshot(ctx context.Context, params *DeleteRelationalDatabaseSnapshotInput, optFns ...func(*Options)) (*DeleteRelationalDatabaseSnapshotOutput, error)

Deletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DetachCertificateFromDistribution 

func (c *Client) DetachCertificateFromDistribution(ctx context.Context, params *DetachCertificateFromDistributionInput, optFns ...func(*Options)) (*DetachCertificateFromDistributionOutput, error)

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.

func (*Client) DetachDisk 

func (c *Client) DetachDisk(ctx context.Context, params *DetachDiskInput, optFns ...func(*Options)) (*DetachDiskOutput, error)

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk. The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DetachInstancesFromLoadBalancer 

func (c *Client) DetachInstancesFromLoadBalancer(ctx context.Context, params *DetachInstancesFromLoadBalancerInput, optFns ...func(*Options)) (*DetachInstancesFromLoadBalancerOutput, error)

Detaches the specified instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from the load balancer. The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) DetachStaticIp 

func (c *Client) DetachStaticIp(ctx context.Context, params *DetachStaticIpInput, optFns ...func(*Options)) (*DetachStaticIpOutput, error)

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

func (*Client) DisableAddOn 

func (c *Client) DisableAddOn(ctx context.Context, params *DisableAddOnInput, optFns ...func(*Options)) (*DisableAddOnOutput, error)

Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).

func (*Client) DownloadDefaultKeyPair 

func (c *Client) DownloadDefaultKeyPair(ctx context.Context, params *DownloadDefaultKeyPairInput, optFns ...func(*Options)) (*DownloadDefaultKeyPairOutput, error)

Downloads the default SSH key pair from the user's account.

func (*Client) EnableAddOn 

func (c *Client) EnableAddOn(ctx context.Context, params *EnableAddOnInput, optFns ...func(*Options)) (*EnableAddOnOutput, error)

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).

func (*Client) ExportSnapshot 

func (c *Client) ExportSnapshot(ctx context.Context, params *ExportSnapshotInput, optFns ...func(*Options)) (*ExportSnapshotOutput, error)

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances. Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags). Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.

func (*Client) GetActiveNames 

func (c *Client) GetActiveNames(ctx context.Context, params *GetActiveNamesInput, optFns ...func(*Options)) (*GetActiveNamesOutput, error)

Returns the names of all active (not deleted) resources.

func (*Client) GetAlarms 

func (c *Client) GetAlarms(ctx context.Context, params *GetAlarmsInput, optFns ...func(*Options)) (*GetAlarmsOutput, error)

Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

func (*Client) GetAutoSnapshots 

func (c *Client) GetAutoSnapshots(ctx context.Context, params *GetAutoSnapshotsInput, optFns ...func(*Options)) (*GetAutoSnapshotsOutput, error)

Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).

func (*Client) GetBlueprints 

func (c *Client) GetBlueprints(ctx context.Context, params *GetBlueprintsInput, optFns ...func(*Options)) (*GetBlueprintsOutput, error)

Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. 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.

func (*Client) GetBundles 

func (c *Client) GetBundles(ctx context.Context, params *GetBundlesInput, optFns ...func(*Options)) (*GetBundlesOutput, error)

Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).

func (*Client) GetCertificates 

func (c *Client) GetCertificates(ctx context.Context, params *GetCertificatesInput, optFns ...func(*Options)) (*GetCertificatesOutput, error)

Returns information about one or more Amazon Lightsail SSL/TLS certificates. To get a summary of a certificate, ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

func (*Client) GetCloudFormationStackRecords 

func (c *Client) GetCloudFormationStackRecords(ctx context.Context, params *GetCloudFormationStackRecordsInput, optFns ...func(*Options)) (*GetCloudFormationStackRecordsOutput, error)

Returns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.

func (*Client) GetContactMethods 

func (c *Client) GetContactMethods(ctx context.Context, params *GetContactMethodsInput, optFns ...func(*Options)) (*GetContactMethodsOutput, error)

Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).

func (*Client) GetContainerAPIMetadata added in v0.30.0 

func (c *Client) GetContainerAPIMetadata(ctx context.Context, params *GetContainerAPIMetadataInput, optFns ...func(*Options)) (*GetContainerAPIMetadataOutput, error)

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

func (*Client) GetContainerImages added in v0.30.0 

func (c *Client) GetContainerImages(ctx context.Context, params *GetContainerImagesInput, optFns ...func(*Options)) (*GetContainerImagesOutput, error)

Returns the container images that are registered to your Amazon Lightsail container service. If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.

func (*Client) GetContainerLog added in v0.30.0 

func (c *Client) GetContainerLog(ctx context.Context, params *GetContainerLogInput, optFns ...func(*Options)) (*GetContainerLogOutput, error)

Returns the log events of a container of your Amazon Lightsail container service. If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service. Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the AWS General Reference.

func (*Client) GetContainerServiceDeployments added in v0.30.0 

func (c *Client) GetContainerServiceDeployments(ctx context.Context, params *GetContainerServiceDeploymentsInput, optFns ...func(*Options)) (*GetContainerServiceDeploymentsOutput, error)

Returns the deployments for your Amazon Lightsail container service A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service. The deployments are ordered by version in ascending order. The newest version is listed at the top of the response. A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the AWS General Reference.

func (*Client) GetContainerServiceMetricData added in v0.30.0 

func (c *Client) GetContainerServiceMetricData(ctx context.Context, params *GetContainerServiceMetricDataInput, optFns ...func(*Options)) (*GetContainerServiceMetricDataOutput, error)

Returns the data points of a specific metric of your Amazon Lightsail container service. Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

func (*Client) GetContainerServicePowers added in v0.30.0 

func (c *Client) GetContainerServicePowers(ctx context.Context, params *GetContainerServicePowersInput, optFns ...func(*Options)) (*GetContainerServicePowersOutput, error)

Returns the list of powers that can be specified for your Amazon Lightsail container services. The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.

func (*Client) GetContainerServices added in v0.30.0 

func (c *Client) GetContainerServices(ctx context.Context, params *GetContainerServicesInput, optFns ...func(*Options)) (*GetContainerServicesOutput, error)

Returns information about one or more of your Amazon Lightsail container services.

func (*Client) GetDisk 

func (c *Client) GetDisk(ctx context.Context, params *GetDiskInput, optFns ...func(*Options)) (*GetDiskOutput, error)

Returns information about a specific block storage disk.

func (*Client) GetDiskSnapshot 

func (c *Client) GetDiskSnapshot(ctx context.Context, params *GetDiskSnapshotInput, optFns ...func(*Options)) (*GetDiskSnapshotOutput, error)

Returns information about a specific block storage disk snapshot.

func (*Client) GetDiskSnapshots 

func (c *Client) GetDiskSnapshots(ctx context.Context, params *GetDiskSnapshotsInput, optFns ...func(*Options)) (*GetDiskSnapshotsOutput, error)

Returns information about all block storage disk snapshots in your AWS account and region.

func (*Client) GetDisks 

func (c *Client) GetDisks(ctx context.Context, params *GetDisksInput, optFns ...func(*Options)) (*GetDisksOutput, error)

Returns information about all block storage disks in your AWS account and region.

func (*Client) GetDistributionBundles 

func (c *Client) GetDistributionBundles(ctx context.Context, params *GetDistributionBundlesInput, optFns ...func(*Options)) (*GetDistributionBundlesOutput, error)

Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions. A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.

func (*Client) GetDistributionLatestCacheReset 

func (c *Client) GetDistributionLatestCacheReset(ctx context.Context, params *GetDistributionLatestCacheResetInput, optFns ...func(*Options)) (*GetDistributionLatestCacheResetOutput, error)

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.

func (*Client) GetDistributionMetricData 

func (c *Client) GetDistributionMetricData(ctx context.Context, params *GetDistributionMetricDataInput, optFns ...func(*Options)) (*GetDistributionMetricDataOutput, error)

Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

func (*Client) GetDistributions 

func (c *Client) GetDistributions(ctx context.Context, params *GetDistributionsInput, optFns ...func(*Options)) (*GetDistributionsOutput, error)

Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.

func (*Client) GetDomain 

func (c *Client) GetDomain(ctx context.Context, params *GetDomainInput, optFns ...func(*Options)) (*GetDomainOutput, error)

Returns information about a specific domain recordset.

func (*Client) GetDomains 

func (c *Client) GetDomains(ctx context.Context, params *GetDomainsInput, optFns ...func(*Options)) (*GetDomainsOutput, error)

Returns a list of all domains in the user's account.

func (*Client) GetExportSnapshotRecords 

func (c *Client) GetExportSnapshotRecords(ctx context.Context, params *GetExportSnapshotRecordsInput, optFns ...func(*Options)) (*GetExportSnapshotRecordsOutput, error)

Returns the export snapshot record created as a result of the export snapshot operation. An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation.

func (*Client) GetInstance 

func (c *Client) GetInstance(ctx context.Context, params *GetInstanceInput, optFns ...func(*Options)) (*GetInstanceOutput, error)

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

func (*Client) GetInstanceAccessDetails 

func (c *Client) GetInstanceAccessDetails(ctx context.Context, params *GetInstanceAccessDetailsInput, optFns ...func(*Options)) (*GetInstanceAccessDetailsOutput, error)

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance. The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) GetInstanceMetricData 

func (c *Client) GetInstanceMetricData(ctx context.Context, params *GetInstanceMetricDataInput, optFns ...func(*Options)) (*GetInstanceMetricDataOutput, error)

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

func (*Client) GetInstancePortStates 

func (c *Client) GetInstancePortStates(ctx context.Context, params *GetInstancePortStatesInput, optFns ...func(*Options)) (*GetInstancePortStatesOutput, error)

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

func (*Client) GetInstanceSnapshot 

func (c *Client) GetInstanceSnapshot(ctx context.Context, params *GetInstanceSnapshotInput, optFns ...func(*Options)) (*GetInstanceSnapshotOutput, error)

Returns information about a specific instance snapshot.

func (*Client) GetInstanceSnapshots 

func (c *Client) GetInstanceSnapshots(ctx context.Context, params *GetInstanceSnapshotsInput, optFns ...func(*Options)) (*GetInstanceSnapshotsOutput, error)

Returns all instance snapshots for the user's account.

func (*Client) GetInstanceState 

func (c *Client) GetInstanceState(ctx context.Context, params *GetInstanceStateInput, optFns ...func(*Options)) (*GetInstanceStateOutput, error)

Returns the state of a specific instance. Works on one instance at a time.

func (*Client) GetInstances 

func (c *Client) GetInstances(ctx context.Context, params *GetInstancesInput, optFns ...func(*Options)) (*GetInstancesOutput, error)

Returns information about all Amazon Lightsail virtual private servers, or instances.

func (*Client) GetKeyPair 

func (c *Client) GetKeyPair(ctx context.Context, params *GetKeyPairInput, optFns ...func(*Options)) (*GetKeyPairOutput, error)

Returns information about a specific key pair.

func (*Client) GetKeyPairs 

func (c *Client) GetKeyPairs(ctx context.Context, params *GetKeyPairsInput, optFns ...func(*Options)) (*GetKeyPairsOutput, error)

Returns information about all key pairs in the user's account.

func (*Client) GetLoadBalancer 

func (c *Client) GetLoadBalancer(ctx context.Context, params *GetLoadBalancerInput, optFns ...func(*Options)) (*GetLoadBalancerOutput, error)

Returns information about the specified Lightsail load balancer.

func (*Client) GetLoadBalancerMetricData 

func (c *Client) GetLoadBalancerMetricData(ctx context.Context, params *GetLoadBalancerMetricDataInput, optFns ...func(*Options)) (*GetLoadBalancerMetricDataOutput, error)

Returns information about health metrics for your Lightsail load balancer. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

func (*Client) GetLoadBalancerTlsCertificates 

func (c *Client) GetLoadBalancerTlsCertificates(ctx context.Context, params *GetLoadBalancerTlsCertificatesInput, optFns ...func(*Options)) (*GetLoadBalancerTlsCertificatesOutput, error)

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.

func (*Client) GetLoadBalancers 

func (c *Client) GetLoadBalancers(ctx context.Context, params *GetLoadBalancersInput, optFns ...func(*Options)) (*GetLoadBalancersOutput, error)

Returns information about all load balancers in an account.

func (*Client) GetOperation 

func (c *Client) GetOperation(ctx context.Context, params *GetOperationInput, optFns ...func(*Options)) (*GetOperationOutput, error)

Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.

func (*Client) GetOperations 

func (c *Client) GetOperations(ctx context.Context, params *GetOperationsInput, optFns ...func(*Options)) (*GetOperationsOutput, error)

Returns information about all operations. Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

func (*Client) GetOperationsForResource 

func (c *Client) GetOperationsForResource(ctx context.Context, params *GetOperationsForResourceInput, optFns ...func(*Options)) (*GetOperationsForResourceOutput, error)

Gets operations for a specific resource (e.g., an instance or a static IP).

func (*Client) GetRegions 

func (c *Client) GetRegions(ctx context.Context, params *GetRegionsInput, optFns ...func(*Options)) (*GetRegionsOutput, error)

Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.

func (*Client) GetRelationalDatabase 

func (c *Client) GetRelationalDatabase(ctx context.Context, params *GetRelationalDatabaseInput, optFns ...func(*Options)) (*GetRelationalDatabaseOutput, error)

Returns information about a specific database in Amazon Lightsail.

func (*Client) GetRelationalDatabaseBlueprints 

func (c *Client) GetRelationalDatabaseBlueprints(ctx context.Context, params *GetRelationalDatabaseBlueprintsInput, optFns ...func(*Options)) (*GetRelationalDatabaseBlueprintsOutput, error)

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. You can use a blueprint ID to create a new database that runs a specific database engine.

func (*Client) GetRelationalDatabaseBundles 

func (c *Client) GetRelationalDatabaseBundles(ctx context.Context, params *GetRelationalDatabaseBundlesInput, optFns ...func(*Options)) (*GetRelationalDatabaseBundlesOutput, error)

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database. You can use a bundle ID to create a new database with explicit performance specifications.

func (*Client) GetRelationalDatabaseEvents 

func (c *Client) GetRelationalDatabaseEvents(ctx context.Context, params *GetRelationalDatabaseEventsInput, optFns ...func(*Options)) (*GetRelationalDatabaseEventsOutput, error)

Returns a list of events for a specific database in Amazon Lightsail.

func (*Client) GetRelationalDatabaseLogEvents 

func (c *Client) GetRelationalDatabaseLogEvents(ctx context.Context, params *GetRelationalDatabaseLogEventsInput, optFns ...func(*Options)) (*GetRelationalDatabaseLogEventsOutput, error)

Returns a list of log events for a database in Amazon Lightsail.

func (*Client) GetRelationalDatabaseLogStreams 

func (c *Client) GetRelationalDatabaseLogStreams(ctx context.Context, params *GetRelationalDatabaseLogStreamsInput, optFns ...func(*Options)) (*GetRelationalDatabaseLogStreamsOutput, error)

Returns a list of available log streams for a specific database in Amazon Lightsail.

func (*Client) GetRelationalDatabaseMasterUserPassword 

func (c *Client) GetRelationalDatabaseMasterUserPassword(ctx context.Context, params *GetRelationalDatabaseMasterUserPasswordInput, optFns ...func(*Options)) (*GetRelationalDatabaseMasterUserPasswordOutput, error)

Returns the current, previous, or pending versions of the master user password for a Lightsail database. The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

func (*Client) GetRelationalDatabaseMetricData 

func (c *Client) GetRelationalDatabaseMetricData(ctx context.Context, params *GetRelationalDatabaseMetricDataInput, optFns ...func(*Options)) (*GetRelationalDatabaseMetricDataOutput, error)

Returns the data points of the specified metric for a database in Amazon Lightsail. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

func (*Client) GetRelationalDatabaseParameters 

func (c *Client) GetRelationalDatabaseParameters(ctx context.Context, params *GetRelationalDatabaseParametersInput, optFns ...func(*Options)) (*GetRelationalDatabaseParametersOutput, error)

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

func (*Client) GetRelationalDatabaseSnapshot 

func (c *Client) GetRelationalDatabaseSnapshot(ctx context.Context, params *GetRelationalDatabaseSnapshotInput, optFns ...func(*Options)) (*GetRelationalDatabaseSnapshotOutput, error)

Returns information about a specific database snapshot in Amazon Lightsail.

func (*Client) GetRelationalDatabaseSnapshots 

func (c *Client) GetRelationalDatabaseSnapshots(ctx context.Context, params *GetRelationalDatabaseSnapshotsInput, optFns ...func(*Options)) (*GetRelationalDatabaseSnapshotsOutput, error)

Returns information about all of your database snapshots in Amazon Lightsail.

func (*Client) GetRelationalDatabases 

func (c *Client) GetRelationalDatabases(ctx context.Context, params *GetRelationalDatabasesInput, optFns ...func(*Options)) (*GetRelationalDatabasesOutput, error)

Returns information about all of your databases in Amazon Lightsail.

func (*Client) GetStaticIp 

func (c *Client) GetStaticIp(ctx context.Context, params *GetStaticIpInput, optFns ...func(*Options)) (*GetStaticIpOutput, error)

Returns information about a specific static IP.

func (*Client) GetStaticIps 

func (c *Client) GetStaticIps(ctx context.Context, params *GetStaticIpsInput, optFns ...func(*Options)) (*GetStaticIpsOutput, error)

Returns information about all static IPs in the user's account.

func (*Client) ImportKeyPair 

func (c *Client) ImportKeyPair(ctx context.Context, params *ImportKeyPairInput, optFns ...func(*Options)) (*ImportKeyPairOutput, error)

Imports a public SSH key from a specific key pair.

func (*Client) IsVpcPeered 

func (c *Client) IsVpcPeered(ctx context.Context, params *IsVpcPeeredInput, optFns ...func(*Options)) (*IsVpcPeeredOutput, error)

Returns a Boolean value indicating whether your Lightsail VPC is peered.

func (*Client) OpenInstancePublicPorts 

func (c *Client) OpenInstancePublicPorts(ctx context.Context, params *OpenInstancePublicPortsInput, optFns ...func(*Options)) (*OpenInstancePublicPortsOutput, error)

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) PeerVpc 

func (c *Client) PeerVpc(ctx context.Context, params *PeerVpcInput, optFns ...func(*Options)) (*PeerVpcOutput, error)

Tries to peer the Lightsail VPC with the user's default VPC.

func (*Client) PutAlarm 

func (c *Client) PutAlarm(ctx context.Context, params *PutAlarmInput, optFns ...func(*Options)) (*PutAlarmOutput, error)

Creates or updates an alarm, and associates it with the specified metric. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms). When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.

func (*Client) PutInstancePublicPorts 

func (c *Client) PutInstancePublicPorts(ctx context.Context, params *PutInstancePublicPortsInput, optFns ...func(*Options)) (*PutInstancePublicPortsOutput, error)

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports. The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) RebootInstance 

func (c *Client) RebootInstance(ctx context.Context, params *RebootInstanceInput, optFns ...func(*Options)) (*RebootInstanceOutput, error)

Restarts a specific instance. The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) RebootRelationalDatabase 

func (c *Client) RebootRelationalDatabase(ctx context.Context, params *RebootRelationalDatabaseInput, optFns ...func(*Options)) (*RebootRelationalDatabaseOutput, error)

Restarts a specific database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) RegisterContainerImage added in v0.30.0 

func (c *Client) RegisterContainerImage(ctx context.Context, params *RegisterContainerImageInput, optFns ...func(*Options)) (*RegisterContainerImageOutput, error)

Registers a container image to your Amazon Lightsail container service. This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images) in the Lightsail Dev Guide.

func (*Client) ReleaseStaticIp 

func (c *Client) ReleaseStaticIp(ctx context.Context, params *ReleaseStaticIpInput, optFns ...func(*Options)) (*ReleaseStaticIpOutput, error)

Deletes a specific static IP from your account.

func (*Client) ResetDistributionCache 

func (c *Client) ResetDistributionCache(ctx context.Context, params *ResetDistributionCacheInput, optFns ...func(*Options)) (*ResetDistributionCacheOutput, error)

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution. After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.

func (*Client) SendContactMethodVerification 

func (c *Client) SendContactMethodVerification(ctx context.Context, params *SendContactMethodVerificationInput, optFns ...func(*Options)) (*SendContactMethodVerificationOutput, error)

Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired. Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.

func (*Client) SetIpAddressType added in v1.2.0 

func (c *Client) SetIpAddressType(ctx context.Context, params *SetIpAddressTypeInput, optFns ...func(*Options)) (*SetIpAddressTypeOutput, error)

Sets the IP address type for an Amazon Lightsail resource. Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.

func (*Client) StartInstance 

func (c *Client) StartInstance(ctx context.Context, params *StartInstanceInput, optFns ...func(*Options)) (*StartInstanceOutput, error)

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip). The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) StartRelationalDatabase 

func (c *Client) StartRelationalDatabase(ctx context.Context, params *StartRelationalDatabaseInput, optFns ...func(*Options)) (*StartRelationalDatabaseOutput, error)

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) StopInstance 

func (c *Client) StopInstance(ctx context.Context, params *StopInstanceInput, optFns ...func(*Options)) (*StopInstanceOutput, error)

Stops a specific Amazon Lightsail instance that is currently running. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip). The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) StopRelationalDatabase 

func (c *Client) StopRelationalDatabase(ctx context.Context, params *StopRelationalDatabaseInput, optFns ...func(*Options)) (*StopRelationalDatabaseOutput, error)

Stops a specific database that is currently running in Amazon Lightsail. The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) TestAlarm 

func (c *Client) TestAlarm(ctx context.Context, params *TestAlarmInput, optFns ...func(*Options)) (*TestAlarmOutput, error)

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

func (*Client) UnpeerVpc 

func (c *Client) UnpeerVpc(ctx context.Context, params *UnpeerVpcInput, optFns ...func(*Options)) (*UnpeerVpcOutput, error)

Attempts to unpeer the Lightsail VPC from the user's default VPC.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) UpdateContainerService added in v0.30.0 

func (c *Client) UpdateContainerService(ctx context.Context, params *UpdateContainerServiceInput, optFns ...func(*Options)) (*UpdateContainerServiceOutput, error)

Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.

func (*Client) UpdateDistribution 

func (c *Client) UpdateDistribution(ctx context.Context, params *UpdateDistributionInput, optFns ...func(*Options)) (*UpdateDistributionOutput, error)

Updates an existing Amazon Lightsail content delivery network (CDN) distribution. Use this action to update the configuration of your existing distribution

func (*Client) UpdateDistributionBundle 

func (c *Client) UpdateDistributionBundle(ctx context.Context, params *UpdateDistributionBundleInput, optFns ...func(*Options)) (*UpdateDistributionBundleOutput, error)

Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution. A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution. Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee. You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.

func (*Client) UpdateDomainEntry 

func (c *Client) UpdateDomainEntry(ctx context.Context, params *UpdateDomainEntryInput, optFns ...func(*Options)) (*UpdateDomainEntryOutput, error)

Updates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) UpdateLoadBalancerAttribute 

func (c *Client) UpdateLoadBalancerAttribute(ctx context.Context, params *UpdateLoadBalancerAttributeInput, optFns ...func(*Options)) (*UpdateLoadBalancerAttributeOutput, error)

Updates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) UpdateRelationalDatabase 

func (c *Client) UpdateRelationalDatabase(ctx context.Context, params *UpdateRelationalDatabaseInput, optFns ...func(*Options)) (*UpdateRelationalDatabaseOutput, error)

Allows the update of one or more attributes of a database in Amazon Lightsail. Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

func (*Client) UpdateRelationalDatabaseParameters 

func (c *Client) UpdateRelationalDatabaseParameters(ctx context.Context, params *UpdateRelationalDatabaseParametersInput, optFns ...func(*Options)) (*UpdateRelationalDatabaseParametersOutput, error)

Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

type CloseInstancePublicPortsInput 

type CloseInstancePublicPortsInput struct {

	// The name of the instance for which to close ports.
	//
	// This member is required.
	InstanceName *string

	// An object to describe the ports to close for the specified instance.
	//
	// This member is required.
	PortInfo *types.PortInfo
}

type CloseInstancePublicPortsOutput 

type CloseInstancePublicPortsOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CopySnapshotInput 

type CopySnapshotInput struct {

	// The AWS Region where the source manual or automatic snapshot is located.
	//
	// This member is required.
	SourceRegion types.RegionName

	// The name of the new manual snapshot to be created as a copy.
	//
	// This member is required.
	TargetSnapshotName *string

	// 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 Lightsail Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots).
	RestoreDate *string

	// The name of the source instance or disk from which the source automatic snapshot
	// was created. Constraint:
	//
	// * Define this parameter only when copying an automatic
	// snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots).
	SourceResourceName *string

	// The name of the source manual snapshot to copy. Constraint:
	//
	// * Define this
	// parameter only when copying a manual snapshot as another manual snapshot.
	SourceSnapshotName *string

	// 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 Lightsail Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots).
	UseLatestRestorableAutoSnapshot *bool
}

type CopySnapshotOutput 

type CopySnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateCertificateInput 

type CreateCertificateInput struct {

	// The name for the certificate.
	//
	// This member is required.
	CertificateName *string

	// The domain name (e.g., example.com) for the certificate.
	//
	// This member is required.
	DomainName *string

	// 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.
	SubjectAlternativeNames []string

	// 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.
	Tags []types.Tag
}

type CreateCertificateOutput 

type CreateCertificateOutput struct {

	// An object that describes the certificate created.
	Certificate *types.CertificateSummary

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateCloudFormationStackInput 

type CreateCloudFormationStackInput struct {

	// 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.
	//
	// This member is required.
	Instances []types.InstanceEntry
}

type CreateCloudFormationStackOutput 

type CreateCloudFormationStackOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateContactMethodInput 

type CreateContactMethodInput struct {

	// 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
	// (https://en.wikipedia.org/wiki/E.164) on Wikipedia.
	//
	// This member is required.
	ContactEndpoint *string

	// The protocol of the contact method, such as Email or SMS (text messaging). The
	// SMS protocol is supported only in the following AWS 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 AWS
	// Regions where SMS text messaging is supported, see Supported Regions and
	// Countries
	// (https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html)
	// in the Amazon SNS Developer Guide. For more information about notifications in
	// Amazon Lightsail, see Notifications in Amazon Lightsail
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).
	//
	// This member is required.
	Protocol types.ContactProtocol
}

type CreateContactMethodOutput 

type CreateContactMethodOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateContainerServiceDeploymentInput added in v0.30.0 

type CreateContainerServiceDeploymentInput struct {

	// The name of the container service for which to create the deployment.
	//
	// This member is required.
	ServiceName *string

	// An object that describes the settings of the containers that will be launched on
	// the container service.
	Containers map[string]types.Container

	// An object that describes the settings of the public endpoint for the container
	// service.
	PublicEndpoint *types.EndpointRequest
}

type CreateContainerServiceDeploymentOutput added in v0.30.0 

type CreateContainerServiceDeploymentOutput struct {

	// An object that describes a container service.
	ContainerService *types.ContainerService

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateContainerServiceInput added in v0.30.0 

type CreateContainerServiceInput struct {

	// 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.
	//
	// This member is required.
	Power types.ContainerServicePowerName

	// 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.
	//
	// This member is required.
	Scale *int32

	// The name for the container service. The name that you specify for your container
	// service will make up part of its default domain. The default domain of a
	// container service is typically https://...cs.amazonlightsail.com. If the name of
	// your container service is container-service-1, and it's located in the US East
	// (Ohio) AWS region (us-east-2), then the domain for your container service will
	// be like the following example:
	// https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com The
	// following are the requirements for container service names:
	//
	// * Must be unique
	// within each AWS 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.
	//
	// This member is required.
	ServiceName *string

	// 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.
	Deployment *types.ContainerServiceDeploymentRequest

	// 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.
	PublicDomainNames map[string][]string

	// The tag keys and optional values for the container service. For more information
	// about tags in Lightsail, see the Lightsail Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags).
	Tags []types.Tag
}

type CreateContainerServiceOutput added in v0.30.0 

type CreateContainerServiceOutput struct {

	// An object that describes a container service.
	ContainerService *types.ContainerService

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateContainerServiceRegistryLoginInput added in v0.30.0 

type CreateContainerServiceRegistryLoginInput struct {
}

type CreateContainerServiceRegistryLoginOutput added in v0.30.0 

type CreateContainerServiceRegistryLoginOutput struct {

	// An object that describes the log in information for the container service
	// registry of your Lightsail account.
	RegistryLogin *types.ContainerServiceRegistryLogin

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDiskFromSnapshotInput 

type CreateDiskFromSnapshotInput struct {

	// 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.
	//
	// This member is required.
	AvailabilityZone *string

	// The unique Lightsail disk name (e.g., my-disk).
	//
	// This member is required.
	DiskName *string

	// The size of the disk in GB (e.g., 32).
	//
	// This member is required.
	SizeInGb *int32

	// An array of objects that represent the add-ons to enable for the new disk.
	AddOns []types.AddOnRequest

	// 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.
	DiskSnapshotName *string

	// 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 Lightsail Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	RestoreDate *string

	// 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 Lightsail Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	SourceDiskName *string

	// 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.
	Tags []types.Tag

	// 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 Lightsail Dev
	// Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	UseLatestRestorableAutoSnapshot *bool
}

type CreateDiskFromSnapshotOutput 

type CreateDiskFromSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDiskInput 

type CreateDiskInput struct {

	// 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.
	//
	// This member is required.
	AvailabilityZone *string

	// The unique Lightsail disk name (e.g., my-disk).
	//
	// This member is required.
	DiskName *string

	// The size of the disk in GB (e.g., 32).
	//
	// This member is required.
	SizeInGb *int32

	// An array of objects that represent the add-ons to enable for the new disk.
	AddOns []types.AddOnRequest

	// 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.
	Tags []types.Tag
}

type CreateDiskOutput 

type CreateDiskOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDiskSnapshotInput 

type CreateDiskSnapshotInput struct {

	// The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the
	// source disk.
	//
	// This member is required.
	DiskSnapshotName *string

	// 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.
	DiskName *string

	// 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.
	InstanceName *string

	// 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.
	Tags []types.Tag
}

type CreateDiskSnapshotOutput 

type CreateDiskSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDistributionInput 

type CreateDistributionInput struct {

	// 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.
	//
	// This member is required.
	BundleId *string

	// An object that describes the default cache behavior for the distribution.
	//
	// This member is required.
	DefaultCacheBehavior *types.CacheBehavior

	// The name for the distribution.
	//
	// This member is required.
	DistributionName *string

	// An object that describes the origin resource for the distribution, such as a
	// Lightsail instance or load balancer. The distribution pulls, caches, and serves
	// content from the origin.
	//
	// This member is required.
	Origin *types.InputOrigin

	// An object that describes the cache behavior settings for the distribution.
	CacheBehaviorSettings *types.CacheSettings

	// An array of objects that describe the per-path cache behavior for the
	// distribution.
	CacheBehaviors []types.CacheBehaviorPerPath

	// 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.
	IpAddressType types.IpAddressType

	// 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.
	Tags []types.Tag
}

type CreateDistributionOutput 

type CreateDistributionOutput struct {

	// An object that describes the distribution created.
	Distribution *types.LightsailDistribution

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDomainEntryInput 

type CreateDomainEntryInput struct {

	// An array of key-value pairs containing information about the domain entry
	// request.
	//
	// This member is required.
	DomainEntry *types.DomainEntry

	// The domain name (e.g., example.com) for which you want to create the domain
	// entry.
	//
	// This member is required.
	DomainName *string
}

type CreateDomainEntryOutput 

type CreateDomainEntryOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDomainInput 

type CreateDomainInput struct {

	// The domain name to manage (e.g., example.com). You cannot register a new domain
	// name using Lightsail. You must register a domain name using Amazon Route 53 or
	// another domain name registrar. If you have already registered your domain, you
	// can enter its name in this parameter to manage the DNS records for that domain.
	//
	// This member is required.
	DomainName *string

	// 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.
	Tags []types.Tag
}

type CreateDomainOutput 

type CreateDomainOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateInstanceSnapshotInput 

type CreateInstanceSnapshotInput struct {

	// The Lightsail instance on which to base your snapshot.
	//
	// This member is required.
	InstanceName *string

	// The name for your new snapshot.
	//
	// This member is required.
	InstanceSnapshotName *string

	// 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.
	Tags []types.Tag
}

type CreateInstanceSnapshotOutput 

type CreateInstanceSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateInstancesFromSnapshotInput 

type CreateInstancesFromSnapshotInput struct {

	// 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
	// (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html)
	// operation. Be sure to add the include Availability Zones parameter to your
	// request.
	//
	// This member is required.
	AvailabilityZone *string

	// The bundle of specification information for your virtual private server (or
	// instance), including the pricing plan (e.g., micro_1_0).
	//
	// This member is required.
	BundleId *string

	// The names for your new instances.
	//
	// This member is required.
	InstanceNames []string

	// An array of objects representing the add-ons to enable for the new instance.
	AddOns []types.AddOnRequest

	// An object containing information about one or more disk mappings.
	AttachedDiskMapping map[string][]types.DiskMap

	// 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.
	InstanceSnapshotName *string

	// 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.
	IpAddressType types.IpAddressType

	// The name for your key pair.
	KeyPairName *string

	// 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 Lightsail Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	RestoreDate *string

	// 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 Lightsail Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	SourceInstanceName *string

	// 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.
	Tags []types.Tag

	// 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 Lightsail
	// Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	UseLatestRestorableAutoSnapshot *bool

	// 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 Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image).
	UserData *string
}

type CreateInstancesFromSnapshotOutput 

type CreateInstancesFromSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateInstancesInput 

type CreateInstancesInput struct {

	// 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
	// (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html)
	// operation. Be sure to add the include Availability Zones parameter to your
	// request.
	//
	// This member is required.
	AvailabilityZone *string

	// 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.
	//
	// This member is required.
	BlueprintId *string

	// The bundle of specification information for your virtual private server (or
	// instance), including the pricing plan (e.g., micro_1_0).
	//
	// This member is required.
	BundleId *string

	// The names to use for your new Lightsail instances. Separate multiple values
	// using quotation marks and commas, for example:
	// ["MyFirstInstance","MySecondInstance"]
	//
	// This member is required.
	InstanceNames []string

	// An array of objects representing the add-ons to enable for the new instance.
	AddOns []types.AddOnRequest

	// (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.
	//
	// Deprecated: This member has been deprecated.
	CustomImageName *string

	// 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.
	IpAddressType types.IpAddressType

	// The name of your key pair.
	KeyPairName *string

	// 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.
	Tags []types.Tag

	// 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 Dev Guide
	// (https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image).
	UserData *string
}

type CreateInstancesOutput 

type CreateInstancesOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateKeyPairInput 

type CreateKeyPairInput struct {

	// The name for your new key pair.
	//
	// This member is required.
	KeyPairName *string

	// 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.
	Tags []types.Tag
}

type CreateKeyPairOutput 

type CreateKeyPairOutput struct {

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

	// 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.
	Operation *types.Operation

	// A base64-encoded RSA private key.
	PrivateKeyBase64 *string

	// A base64-encoded public key of the ssh-rsa type.
	PublicKeyBase64 *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateLoadBalancerInput 

type CreateLoadBalancerInput struct {

	// The instance port where you're creating your load balancer.
	//
	// This member is required.
	InstancePort int32

	// The name of your load balancer.
	//
	// This member is required.
	LoadBalancerName *string

	// 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).
	CertificateAlternativeNames []string

	// The domain name with which your certificate is associated (e.g., example.com).
	// If you specify certificateDomainName, then certificateName is required (and
	// vice-versa).
	CertificateDomainName *string

	// The name of the SSL/TLS certificate. If you specify certificateName, then
	// certificateDomainName is required (and vice-versa).
	CertificateName *string

	// 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.
	HealthCheckPath *string

	// 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.
	IpAddressType types.IpAddressType

	// 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.
	Tags []types.Tag
}

type CreateLoadBalancerOutput 

type CreateLoadBalancerOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateLoadBalancerTlsCertificateInput 

type CreateLoadBalancerTlsCertificateInput struct {

	// The domain name (e.g., example.com) for your SSL/TLS certificate.
	//
	// This member is required.
	CertificateDomainName *string

	// 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 (http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html).
	//
	// This member is required.
	CertificateName *string

	// The load balancer name where you want to create the SSL/TLS certificate.
	//
	// This member is required.
	LoadBalancerName *string

	// 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).
	CertificateAlternativeNames []string

	// 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.
	Tags []types.Tag
}

type CreateLoadBalancerTlsCertificateOutput 

type CreateLoadBalancerTlsCertificateOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRelationalDatabaseFromSnapshotInput 

type CreateRelationalDatabaseFromSnapshotInput struct {

	// The name to use for your new database. Constraints:
	//
	// * Must contain from 2 to
	// 255 alphanumeric characters, or hyphens.
	//
	// * The first and last character must be
	// a letter or number.
	//
	// This member is required.
	RelationalDatabaseName *string

	// The Availability Zone in which to create your new database. Use the us-east-2a
	// case-sensitive format. You can get a list of Availability Zones by using the get
	// regions operation. Be sure to add the include relational database Availability
	// Zones parameter to your request.
	AvailabilityZone *string

	// 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.
	PubliclyAccessible *bool

	// 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.
	RelationalDatabaseBundleId *string

	// The name of the database snapshot from which to create your new database.
	RelationalDatabaseSnapshotName *string

	// 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.
	RestoreTime *time.Time

	// The name of the source database.
	SourceRelationalDatabaseName *string

	// 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.
	Tags []types.Tag

	// 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.
	UseLatestRestorableTime *bool
}

type CreateRelationalDatabaseFromSnapshotOutput 

type CreateRelationalDatabaseFromSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRelationalDatabaseInput 

type CreateRelationalDatabaseInput struct {

	// The name of the master database created when the Lightsail database resource is
	// created. Constraints:
	//
	// * Must contain from 1 to 64 alphanumeric characters.
	//
	// *
	// Cannot be a word reserved by the specified database engine
	//
	// This member is required.
	MasterDatabaseName *string

	// The master user name for your new database. Constraints:
	//
	// * Master user name is
	// required.
	//
	// * Must contain from 1 to 16 alphanumeric characters.
	//
	// * The first
	// character must be a letter.
	//
	// * Cannot be a reserved word for the database engine
	// you choose. For more information about reserved words in MySQL 5.6 or 5.7, see
	// the Keywords and Reserved Words articles for MySQL 5.6
	// (https://dev.mysql.com/doc/refman/5.6/en/keywords.html) or MySQL 5.7
	// (https://dev.mysql.com/doc/refman/5.7/en/keywords.html) respectively.
	//
	// This member is required.
	MasterUsername *string

	// The blueprint ID for your new database. A blueprint describes the major engine
	// version of a database. You can get a list of database blueprints IDs by using
	// the get relational database blueprints operation.
	//
	// This member is required.
	RelationalDatabaseBlueprintId *string

	// The bundle ID for your new database. A bundle describes the performance
	// specifications for your database. You can get a list of database bundle IDs by
	// using the get relational database bundles operation.
	//
	// This member is required.
	RelationalDatabaseBundleId *string

	// The name to use for your new Lightsail database resource. Constraints:
	//
	// * Must
	// contain from 2 to 255 alphanumeric characters, or hyphens.
	//
	// * The first and last
	// character must be a letter or number.
	//
	// This member is required.
	RelationalDatabaseName *string

	// The Availability Zone in which to create your new database. Use the us-east-2a
	// case-sensitive format. You can get a list of Availability Zones by using the get
	// regions operation. Be sure to add the include relational database Availability
	// Zones parameter to your request.
	AvailabilityZone *string

	// The password for the master user of your new database. The password can include
	// any printable ASCII character except "/", """, or "@". Constraints: Must contain
	// 8 to 41 characters.
	MasterUserPassword *string

	// The daily time range during which automated backups are created for your new
	// database if automated backups are enabled. The default is a 30-minute window
	// selected at random from an 8-hour block of time for each AWS Region. For more
	// information about the preferred backup window time blocks for each region, see
	// the Working With Backups
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
	// guide in the Amazon Relational Database Service (Amazon RDS) documentation.
	// Constraints:
	//
	// * Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30
	//
	// *
	// Specified in Coordinated Universal Time (UTC).
	//
	// * Must not conflict with the
	// preferred maintenance window.
	//
	// * Must be at least 30 minutes.
	PreferredBackupWindow *string

	// The weekly time range during which system maintenance can occur on your new
	// database. The default is a 30-minute window selected at random from an 8-hour
	// block of time for each AWS Region, occurring on a random day of the week.
	// Constraints:
	//
	// * Must be in the ddd:hh24:mi-ddd:hh24:mi format.
	//
	// * Valid days:
	// Mon, Tue, Wed, Thu, Fri, Sat, Sun.
	//
	// * Must be at least 30 minutes.
	//
	// * Specified
	// in Coordinated Universal Time (UTC).
	//
	// * Example: Tue:17:00-Tue:17:30
	PreferredMaintenanceWindow *string

	// 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.
	PubliclyAccessible *bool

	// 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.
	Tags []types.Tag
}

type CreateRelationalDatabaseOutput 

type CreateRelationalDatabaseOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRelationalDatabaseSnapshotInput 

type CreateRelationalDatabaseSnapshotInput struct {

	// The name of the database on which to base your new snapshot.
	//
	// This member is required.
	RelationalDatabaseName *string

	// 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.
	//
	// This member is required.
	RelationalDatabaseSnapshotName *string

	// 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.
	Tags []types.Tag
}

type CreateRelationalDatabaseSnapshotOutput 

type CreateRelationalDatabaseSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAlarmInput 

type DeleteAlarmInput struct {

	// The name of the alarm to delete.
	//
	// This member is required.
	AlarmName *string
}

type DeleteAlarmOutput 

type DeleteAlarmOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAutoSnapshotInput 

type DeleteAutoSnapshotInput struct {

	// 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.
	//
	// This member is required.
	Date *string

	// The name of the source instance or disk from which to delete the automatic
	// snapshot.
	//
	// This member is required.
	ResourceName *string
}

type DeleteAutoSnapshotOutput 

type DeleteAutoSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteCertificateInput 

type DeleteCertificateInput struct {

	// The name of the certificate to delete. Use the GetCertificates action to get a
	// list of certificate names that you can specify.
	//
	// This member is required.
	CertificateName *string
}

type DeleteCertificateOutput 

type DeleteCertificateOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteContactMethodInput 

type DeleteContactMethodInput struct {

	// 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.
	//
	// This member is required.
	Protocol types.ContactProtocol
}

type DeleteContactMethodOutput 

type DeleteContactMethodOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteContainerImageInput added in v0.30.0 

type DeleteContainerImageInput struct {

	// 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.
	//
	// This member is required.
	Image *string

	// The name of the container service for which to delete a registered container
	// image.
	//
	// This member is required.
	ServiceName *string
}

type DeleteContainerImageOutput added in v0.30.0 

type DeleteContainerImageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteContainerServiceInput added in v0.30.0 

type DeleteContainerServiceInput struct {

	// The name of the container service to delete.
	//
	// This member is required.
	ServiceName *string
}

type DeleteContainerServiceOutput added in v0.30.0 

type DeleteContainerServiceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDiskInput 

type DeleteDiskInput struct {

	// The unique name of the disk you want to delete (e.g., my-disk).
	//
	// This member is required.
	DiskName *string

	// A Boolean value to indicate whether to delete the enabled add-ons for the disk.
	ForceDeleteAddOns *bool
}

type DeleteDiskOutput 

type DeleteDiskOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDiskSnapshotInput 

type DeleteDiskSnapshotInput struct {

	// The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).
	//
	// This member is required.
	DiskSnapshotName *string
}

type DeleteDiskSnapshotOutput 

type DeleteDiskSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDistributionInput 

type DeleteDistributionInput struct {

	// The name of the distribution to delete. Use the GetDistributions action to get a
	// list of distribution names that you can specify.
	DistributionName *string
}

type DeleteDistributionOutput 

type DeleteDistributionOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDomainEntryInput 

type DeleteDomainEntryInput struct {

	// An array of key-value pairs containing information about your domain entries.
	//
	// This member is required.
	DomainEntry *types.DomainEntry

	// The name of the domain entry to delete.
	//
	// This member is required.
	DomainName *string
}

type DeleteDomainEntryOutput 

type DeleteDomainEntryOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDomainInput 

type DeleteDomainInput struct {

	// The specific domain name to delete.
	//
	// This member is required.
	DomainName *string
}

type DeleteDomainOutput 

type DeleteDomainOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteInstanceInput 

type DeleteInstanceInput struct {

	// The name of the instance to delete.
	//
	// This member is required.
	InstanceName *string

	// A Boolean value to indicate whether to delete the enabled add-ons for the disk.
	ForceDeleteAddOns *bool
}

type DeleteInstanceOutput 

type DeleteInstanceOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteInstanceSnapshotInput 

type DeleteInstanceSnapshotInput struct {

	// The name of the snapshot to delete.
	//
	// This member is required.
	InstanceSnapshotName *string
}

type DeleteInstanceSnapshotOutput 

type DeleteInstanceSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteKeyPairInput 

type DeleteKeyPairInput struct {

	// The name of the key pair to delete.
	//
	// This member is required.
	KeyPairName *string
}

type DeleteKeyPairOutput 

type DeleteKeyPairOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteKnownHostKeysInput 

type DeleteKnownHostKeysInput struct {

	// The name of the instance for which you want to reset the host key or
	// certificate.
	//
	// This member is required.
	InstanceName *string
}

type DeleteKnownHostKeysOutput 

type DeleteKnownHostKeysOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteLoadBalancerInput 

type DeleteLoadBalancerInput struct {

	// The name of the load balancer you want to delete.
	//
	// This member is required.
	LoadBalancerName *string
}

type DeleteLoadBalancerOutput 

type DeleteLoadBalancerOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteLoadBalancerTlsCertificateInput 

type DeleteLoadBalancerTlsCertificateInput struct {

	// The SSL/TLS certificate name.
	//
	// This member is required.
	CertificateName *string

	// The load balancer name.
	//
	// This member is required.
	LoadBalancerName *string

	// 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.
	Force *bool
}

type DeleteLoadBalancerTlsCertificateOutput 

type DeleteLoadBalancerTlsCertificateOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRelationalDatabaseInput 

type DeleteRelationalDatabaseInput struct {

	// The name of the database that you are deleting.
	//
	// This member is required.
	RelationalDatabaseName *string

	// 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.
	FinalRelationalDatabaseSnapshotName *string

	// 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
	SkipFinalSnapshot *bool
}

type DeleteRelationalDatabaseOutput 

type DeleteRelationalDatabaseOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRelationalDatabaseSnapshotInput 

type DeleteRelationalDatabaseSnapshotInput struct {

	// The name of the database snapshot that you are deleting.
	//
	// This member is required.
	RelationalDatabaseSnapshotName *string
}

type DeleteRelationalDatabaseSnapshotOutput 

type DeleteRelationalDatabaseSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetachCertificateFromDistributionInput 

type DetachCertificateFromDistributionInput struct {

	// 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.
	//
	// This member is required.
	DistributionName *string
}

type DetachCertificateFromDistributionOutput 

type DetachCertificateFromDistributionOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetachDiskInput 

type DetachDiskInput struct {

	// The unique name of the disk you want to detach from your instance (e.g.,
	// my-disk).
	//
	// This member is required.
	DiskName *string
}

type DetachDiskOutput 

type DetachDiskOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetachInstancesFromLoadBalancerInput 

type DetachInstancesFromLoadBalancerInput struct {

	// An array of strings containing the names of the instances you want to detach
	// from the load balancer.
	//
	// This member is required.
	InstanceNames []string

	// The name of the Lightsail load balancer.
	//
	// This member is required.
	LoadBalancerName *string
}

type DetachInstancesFromLoadBalancerOutput 

type DetachInstancesFromLoadBalancerOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetachStaticIpInput 

type DetachStaticIpInput struct {

	// The name of the static IP to detach from the instance.
	//
	// This member is required.
	StaticIpName *string
}

type DetachStaticIpOutput 

type DetachStaticIpOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisableAddOnInput 

type DisableAddOnInput struct {

	// The add-on type to disable.
	//
	// This member is required.
	AddOnType types.AddOnType

	// The name of the source resource for which to disable the add-on.
	//
	// This member is required.
	ResourceName *string
}

type DisableAddOnOutput 

type DisableAddOnOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DownloadDefaultKeyPairInput 

type DownloadDefaultKeyPairInput struct {
}

type DownloadDefaultKeyPairOutput 

type DownloadDefaultKeyPairOutput struct {

	// A base64-encoded RSA private key.
	PrivateKeyBase64 *string

	// A base64-encoded public key of the ssh-rsa type.
	PublicKeyBase64 *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EnableAddOnInput 

type EnableAddOnInput struct {

	// An array of strings representing the add-on to enable or modify.
	//
	// This member is required.
	AddOnRequest *types.AddOnRequest

	// The name of the source resource for which to enable or modify the add-on.
	//
	// This member is required.
	ResourceName *string
}

type EnableAddOnOutput 

type EnableAddOnOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type ExportSnapshotInput 

type ExportSnapshotInput struct {

	// The name of the instance or disk snapshot to be exported to Amazon EC2.
	//
	// This member is required.
	SourceSnapshotName *string
}

type ExportSnapshotOutput 

type ExportSnapshotOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetActiveNamesInput 

type GetActiveNamesInput struct {

	// 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.
	PageToken *string
}

type GetActiveNamesOutput 

type GetActiveNamesOutput struct {

	// The list of active names returned by the get active names request.
	ActiveNames []string

	// The token to advance to the next page of results from your request. A next page
	// token is not returned if there are no more results to display. To get the next
	// page of results, perform another GetActiveNames request and specify the next
	// page token using the pageToken parameter.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAlarmsInput 

type GetAlarmsInput struct {

	// The name of the alarm. Specify an alarm name to return information about a
	// specific alarm.
	AlarmName *string

	// 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.
	MonitoredResourceName *string

	// 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.
	PageToken *string
}

type GetAlarmsOutput 

type GetAlarmsOutput struct {

	// An array of objects that describe the alarms.
	Alarms []types.Alarm

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetAutoSnapshotsInput 

type GetAutoSnapshotsInput struct {

	// The name of the source instance or disk from which to get automatic snapshot
	// information.
	//
	// This member is required.
	ResourceName *string
}

type GetAutoSnapshotsOutput 

type GetAutoSnapshotsOutput struct {

	// An array of objects that describe the automatic snapshots that are available for
	// the specified source instance or disk.
	AutoSnapshots []types.AutoSnapshotDetails

	// The name of the source instance or disk for the automatic snapshots.
	ResourceName *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetBlueprintsInput 

type GetBlueprintsInput struct {

	// A Boolean value indicating whether to include inactive results in your request.
	IncludeInactive *bool

	// 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.
	PageToken *string
}

type GetBlueprintsOutput 

type GetBlueprintsOutput struct {

	// An array of key-value pairs that contains information about the available
	// blueprints.
	Blueprints []types.Blueprint

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetBundlesInput 

type GetBundlesInput struct {

	// A Boolean value that indicates whether to include inactive bundle results in
	// your request.
	IncludeInactive *bool

	// 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.
	PageToken *string
}

type GetBundlesOutput 

type GetBundlesOutput struct {

	// An array of key-value pairs that contains information about the available
	// bundles.
	Bundles []types.Bundle

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetCertificatesInput 

type GetCertificatesInput struct {

	// The name for the certificate for which to return information. When omitted, the
	// response includes all of your certificates in the AWS Region where the request
	// is made.
	CertificateName *string

	// 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 AWS Region where the
	// request is made, regardless of their current status.
	CertificateStatuses []types.CertificateStatus

	// 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.
	IncludeCertificateDetails bool
}

type GetCertificatesOutput 

type GetCertificatesOutput struct {

	// An object that describes certificates.
	Certificates []types.CertificateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetCloudFormationStackRecordsInput 

type GetCloudFormationStackRecordsInput struct {

	// 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.
	PageToken *string
}

type GetCloudFormationStackRecordsOutput 

type GetCloudFormationStackRecordsOutput struct {

	// A list of objects describing the CloudFormation stack records.
	CloudFormationStackRecords []types.CloudFormationStackRecord

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContactMethodsInput 

type GetContactMethodsInput struct {

	// 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.
	Protocols []types.ContactProtocol
}

type GetContactMethodsOutput 

type GetContactMethodsOutput struct {

	// An array of objects that describe the contact methods.
	ContactMethods []types.ContactMethod

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerAPIMetadataInput added in v0.30.0 

type GetContainerAPIMetadataInput struct {
}

type GetContainerAPIMetadataOutput added in v0.30.0 

type GetContainerAPIMetadataOutput struct {

	// Metadata about Lightsail containers, such as the current version of the
	// Lightsail Control (lightsailctl) plugin.
	Metadata []map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerImagesInput added in v0.30.0 

type GetContainerImagesInput struct {

	// The name of the container service for which to return registered container
	// images.
	//
	// This member is required.
	ServiceName *string
}

type GetContainerImagesOutput added in v0.30.0 

type GetContainerImagesOutput struct {

	// An array of objects that describe container images that are registered to the
	// container service.
	ContainerImages []types.ContainerImage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerLogInput added in v0.30.0 

type GetContainerLogInput struct {

	// The name of the container that is either running or previously ran on the
	// container service for which to return a log.
	//
	// This member is required.
	ContainerName *string

	// The name of the container service for which to get a container log.
	//
	// This member is required.
	ServiceName *string

	// 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
	// (https://www.epochconverter.com/).
	EndTime *time.Time

	// 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".
	FilterPattern *string

	// The token to advance to the next page of results from your request. To get a
	// page token, perform an initial GetContainerLog request. If your results are
	// paginated, the response will return a next page token that you can specify as
	// the page token in a subsequent request.
	PageToken *string

	// 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
	// (https://www.epochconverter.com/).
	StartTime *time.Time
}

type GetContainerLogOutput added in v0.30.0 

type GetContainerLogOutput struct {

	// An array of objects that describe the log events of a container.
	LogEvents []types.ContainerServiceLogEvent

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerServiceDeploymentsInput added in v0.30.0 

type GetContainerServiceDeploymentsInput struct {

	// The name of the container service for which to return deployments.
	//
	// This member is required.
	ServiceName *string
}

type GetContainerServiceDeploymentsOutput added in v0.30.0 

type GetContainerServiceDeploymentsOutput struct {

	// An array of objects that describe deployments for a container service.
	Deployments []types.ContainerServiceDeployment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerServiceMetricDataInput added in v0.30.0 

type GetContainerServiceMetricDataInput struct {

	// The end time of the time period.
	//
	// This member is required.
	EndTime *time.Time

	// 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.
	//
	// This member is required.
	MetricName types.ContainerServiceMetricName

	// The granularity, in seconds, of the returned data points. All container service
	// metric data is available in 5-minute (300 seconds) granularity.
	//
	// This member is required.
	Period int32

	// The name of the container service for which to get metric data.
	//
	// This member is required.
	ServiceName *string

	// The start time of the time period.
	//
	// This member is required.
	StartTime *time.Time

	// 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.
	//
	// This member is required.
	Statistics []types.MetricStatistic
}

type GetContainerServiceMetricDataOutput added in v0.30.0 

type GetContainerServiceMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []types.MetricDatapoint

	// The name of the metric returned.
	MetricName types.ContainerServiceMetricName

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerServicePowersInput added in v0.30.0 

type GetContainerServicePowersInput struct {
}

type GetContainerServicePowersOutput added in v0.30.0 

type GetContainerServicePowersOutput struct {

	// An array of objects that describe the powers that can be specified for a
	// container service.
	Powers []types.ContainerServicePower

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetContainerServicesInput added in v0.30.0 

type GetContainerServicesInput struct {

	// The name of the container service for which to return information. When omitted,
	// the response includes all of your container services in the AWS Region where the
	// request is made.
	ServiceName *string
}

type GetContainerServicesOutput added in v0.30.0 

type GetContainerServicesOutput struct {

	// An array of objects that describe one or more container services.
	ContainerServices []types.ContainerService

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDiskInput 

type GetDiskInput struct {

	// The name of the disk (e.g., my-disk).
	//
	// This member is required.
	DiskName *string
}

type GetDiskOutput 

type GetDiskOutput struct {

	// An object containing information about the disk.
	Disk *types.Disk

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDiskSnapshotInput 

type GetDiskSnapshotInput struct {

	// The name of the disk snapshot (e.g., my-disk-snapshot).
	//
	// This member is required.
	DiskSnapshotName *string
}

type GetDiskSnapshotOutput 

type GetDiskSnapshotOutput struct {

	// An object containing information about the disk snapshot.
	DiskSnapshot *types.DiskSnapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDiskSnapshotsInput 

type GetDiskSnapshotsInput struct {

	// 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.
	PageToken *string
}

type GetDiskSnapshotsOutput 

type GetDiskSnapshotsOutput struct {

	// An array of objects containing information about all block storage disk
	// snapshots.
	DiskSnapshots []types.DiskSnapshot

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDisksInput 

type GetDisksInput struct {

	// 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.
	PageToken *string
}

type GetDisksOutput 

type GetDisksOutput struct {

	// An array of objects containing information about all block storage disks.
	Disks []types.Disk

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDistributionBundlesInput 

type GetDistributionBundlesInput struct {
}

type GetDistributionBundlesOutput 

type GetDistributionBundlesOutput struct {

	// An object that describes a distribution bundle.
	Bundles []types.DistributionBundle

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDistributionLatestCacheResetInput 

type GetDistributionLatestCacheResetInput struct {

	// 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.
	DistributionName *string
}

type GetDistributionLatestCacheResetOutput 

type GetDistributionLatestCacheResetOutput struct {

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

	// The status of the last cache reset.
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDistributionMetricDataInput 

type GetDistributionMetricDataInput struct {

	// 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.
	//
	// This member is required.
	DistributionName *string

	// 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
	// (https://www.epochconverter.com/).
	//
	// This member is required.
	EndTime *time.Time

	// 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.
	//
	// This member is required.
	MetricName types.DistributionMetricName

	// The granularity, in seconds, for the metric data points that will be returned.
	//
	// This member is required.
	Period int32

	// 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
	// (https://www.epochconverter.com/).
	//
	// This member is required.
	StartTime *time.Time

	// 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.
	//
	// This member is required.
	Statistics []types.MetricStatistic

	// 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.
	//
	// This member is required.
	Unit types.MetricUnit
}

type GetDistributionMetricDataOutput 

type GetDistributionMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []types.MetricDatapoint

	// The name of the metric returned.
	MetricName types.DistributionMetricName

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDistributionsInput 

type GetDistributionsInput struct {

	// The name of the distribution for which to return information. Use the
	// GetDistributions action to get a list of distribution names that you can
	// specify. When omitted, the response includes all of your distributions in the
	// AWS Region where the request is made.
	DistributionName *string

	// 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.
	PageToken *string
}

type GetDistributionsOutput 

type GetDistributionsOutput struct {

	// An array of objects that describe your distributions.
	Distributions []types.LightsailDistribution

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDomainInput 

type GetDomainInput struct {

	// The domain name for which your want to return information about.
	//
	// This member is required.
	DomainName *string
}

type GetDomainOutput 

type GetDomainOutput struct {

	// An array of key-value pairs containing information about your get domain
	// request.
	Domain *types.Domain

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDomainsInput 

type GetDomainsInput struct {

	// 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.
	PageToken *string
}

type GetDomainsOutput 

type GetDomainsOutput struct {

	// An array of key-value pairs containing information about each of the domain
	// entries in the user's account.
	Domains []types.Domain

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetExportSnapshotRecordsInput 

type GetExportSnapshotRecordsInput struct {

	// 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.
	PageToken *string
}

type GetExportSnapshotRecordsOutput 

type GetExportSnapshotRecordsOutput struct {

	// A list of objects describing the export snapshot records.
	ExportSnapshotRecords []types.ExportSnapshotRecord

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInstanceAccessDetailsInput 

type GetInstanceAccessDetailsInput struct {

	// The name of the instance to access.
	//
	// This member is required.
	InstanceName *string

	// The protocol to use to connect to your instance. Defaults to ssh.
	Protocol types.InstanceAccessProtocol
}

type GetInstanceAccessDetailsOutput 

type GetInstanceAccessDetailsOutput struct {

	// An array of key-value pairs containing information about a get instance access
	// request.
	AccessDetails *types.InstanceAccessDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInstanceInput 

type GetInstanceInput struct {

	// The name of the instance.
	//
	// This member is required.
	InstanceName *string
}

type GetInstanceMetricDataInput 

type GetInstanceMetricDataInput struct {

	// The end time of the time period.
	//
	// This member is required.
	EndTime *time.Time

	// The name of the instance for which you want to get metrics data.
	//
	// This member is required.
	InstanceName *string

	// 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
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity).
	// 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
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity).
	// 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.
	//
	// This member is required.
	MetricName types.InstanceMetricName

	// 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.
	//
	// This member is required.
	Period int32

	// The start time of the time period.
	//
	// This member is required.
	StartTime *time.Time

	// 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.
	//
	// This member is required.
	Statistics []types.MetricStatistic

	// 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.
	//
	// This member is required.
	Unit types.MetricUnit
}

type GetInstanceMetricDataOutput 

type GetInstanceMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []types.MetricDatapoint

	// The name of the metric returned.
	MetricName types.InstanceMetricName

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInstanceOutput 

type GetInstanceOutput struct {

	// An array of key-value pairs containing information about the specified instance.
	Instance *types.Instance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInstancePortStatesInput 

type GetInstancePortStatesInput struct {

	// The name of the instance for which to return firewall port states.
	//
	// This member is required.
	InstanceName *string
}

type GetInstancePortStatesOutput 

type GetInstancePortStatesOutput struct {

	// An array of objects that describe the firewall port states for the specified
	// instance.
	PortStates []types.InstancePortState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInstanceSnapshotInput 

type GetInstanceSnapshotInput struct {

	// The name of the snapshot for which you are requesting information.
	//
	// This member is required.
	InstanceSnapshotName *string
}

type GetInstanceSnapshotOutput 

type GetInstanceSnapshotOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInstanceSnapshotsInput 

type GetInstanceSnapshotsInput struct {

	// 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.
	PageToken *string
}

type GetInstanceSnapshotsOutput 

type GetInstanceSnapshotsOutput struct {

	// An array of key-value pairs containing information about the results of your get
	// instance snapshots request.
	InstanceSnapshots []types.InstanceSnapshot

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInstanceStateInput 

type GetInstanceStateInput struct {

	// The name of the instance to get state information about.
	//
	// This member is required.
	InstanceName *string
}

type GetInstanceStateOutput 

type GetInstanceStateOutput struct {

	// The state of the instance.
	State *types.InstanceState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetInstancesInput 

type GetInstancesInput struct {

	// 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.
	PageToken *string
}

type GetInstancesOutput 

type GetInstancesOutput struct {

	// An array of key-value pairs containing information about your instances.
	Instances []types.Instance

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetKeyPairInput 

type GetKeyPairInput struct {

	// The name of the key pair for which you are requesting information.
	//
	// This member is required.
	KeyPairName *string
}

type GetKeyPairOutput 

type GetKeyPairOutput struct {

	// An array of key-value pairs containing information about the key pair.
	KeyPair *types.KeyPair

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetKeyPairsInput 

type GetKeyPairsInput struct {

	// 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.
	PageToken *string
}

type GetKeyPairsOutput 

type GetKeyPairsOutput struct {

	// An array of key-value pairs containing information about the key pairs.
	KeyPairs []types.KeyPair

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLoadBalancerInput 

type GetLoadBalancerInput struct {

	// The name of the load balancer.
	//
	// This member is required.
	LoadBalancerName *string
}

type GetLoadBalancerMetricDataInput 

type GetLoadBalancerMetricDataInput struct {

	// The end time of the period.
	//
	// This member is required.
	EndTime *time.Time

	// The name of the load balancer.
	//
	// This member is required.
	LoadBalancerName *string

	// 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.
	//
	// This member is required.
	MetricName types.LoadBalancerMetricName

	// The granularity, in seconds, of the returned data points.
	//
	// This member is required.
	Period int32

	// The start time of the period.
	//
	// This member is required.
	StartTime *time.Time

	// 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.
	//
	// This member is required.
	Statistics []types.MetricStatistic

	// 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.
	//
	// This member is required.
	Unit types.MetricUnit
}

type GetLoadBalancerMetricDataOutput 

type GetLoadBalancerMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []types.MetricDatapoint

	// The name of the metric returned.
	MetricName types.LoadBalancerMetricName

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLoadBalancerOutput 

type GetLoadBalancerOutput struct {

	// An object containing information about your load balancer.
	LoadBalancer *types.LoadBalancer

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLoadBalancerTlsCertificatesInput 

type GetLoadBalancerTlsCertificatesInput struct {

	// The name of the load balancer you associated with your SSL/TLS certificate.
	//
	// This member is required.
	LoadBalancerName *string
}

type GetLoadBalancerTlsCertificatesOutput 

type GetLoadBalancerTlsCertificatesOutput struct {

	// An array of LoadBalancerTlsCertificate objects describing your SSL/TLS
	// certificates.
	TlsCertificates []types.LoadBalancerTlsCertificate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLoadBalancersInput 

type GetLoadBalancersInput struct {

	// 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.
	PageToken *string
}

type GetLoadBalancersOutput 

type GetLoadBalancersOutput struct {

	// An array of LoadBalancer objects describing your load balancers.
	LoadBalancers []types.LoadBalancer

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetOperationInput 

type GetOperationInput struct {

	// A GUID used to identify the operation.
	//
	// This member is required.
	OperationId *string
}

type GetOperationOutput 

type GetOperationOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetOperationsForResourceInput 

type GetOperationsForResourceInput struct {

	// The name of the resource for which you are requesting information.
	//
	// This member is required.
	ResourceName *string

	// 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.
	PageToken *string
}

type GetOperationsForResourceOutput 

type GetOperationsForResourceOutput struct {

	// (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.
	//
	// Deprecated: This member has been deprecated.
	NextPageCount *string

	// The token to advance to the next page of results from your request. A next page
	// token is not returned if there are no more results to display. To get the next
	// page of results, perform another GetOperationsForResource request and specify
	// the next page token using the pageToken parameter.
	NextPageToken *string

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetOperationsInput 

type GetOperationsInput struct {

	// 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.
	PageToken *string
}

type GetOperationsOutput 

type GetOperationsOutput struct {

	// 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.
	NextPageToken *string

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRegionsInput 

type GetRegionsInput struct {

	// 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.
	IncludeAvailabilityZones *bool

	// 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).
	IncludeRelationalDatabaseAvailabilityZones *bool
}

type GetRegionsOutput 

type GetRegionsOutput struct {

	// An array of key-value pairs containing information about your get regions
	// request.
	Regions []types.Region

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseBlueprintsInput 

type GetRelationalDatabaseBlueprintsInput struct {

	// 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.
	PageToken *string
}

type GetRelationalDatabaseBlueprintsOutput 

type GetRelationalDatabaseBlueprintsOutput struct {

	// An object describing the result of your get relational database blueprints
	// request.
	Blueprints []types.RelationalDatabaseBlueprint

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseBundlesInput 

type GetRelationalDatabaseBundlesInput struct {

	// 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.
	PageToken *string
}

type GetRelationalDatabaseBundlesOutput 

type GetRelationalDatabaseBundlesOutput struct {

	// An object describing the result of your get relational database bundles request.
	Bundles []types.RelationalDatabaseBundle

	// 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.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseEventsInput 

type GetRelationalDatabaseEventsInput struct {

	// The name of the database from which to get events.
	//
	// This member is required.
	RelationalDatabaseName *string

	// 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).
	DurationInMinutes *int32

	// 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.
	PageToken *string
}

type GetRelationalDatabaseEventsOutput 

type GetRelationalDatabaseEventsOutput struct {

	// 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.
	NextPageToken *string

	// An object describing the result of your get relational database events request.
	RelationalDatabaseEvents []types.RelationalDatabaseEvent

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseInput 

type GetRelationalDatabaseInput struct {

	// The name of the database that you are looking up.
	//
	// This member is required.
	RelationalDatabaseName *string
}

type GetRelationalDatabaseLogEventsInput 

type GetRelationalDatabaseLogEventsInput struct {

	// The name of the log stream. Use the get relational database log streams
	// operation to get a list of available log streams.
	//
	// This member is required.
	LogStreamName *string

	// The name of your database for which to get log events.
	//
	// This member is required.
	RelationalDatabaseName *string

	// 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.
	EndTime *time.Time

	// 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.
	PageToken *string

	// 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.
	StartFromHead *bool

	// 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.
	StartTime *time.Time
}

type GetRelationalDatabaseLogEventsOutput 

type GetRelationalDatabaseLogEventsOutput struct {

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

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

	// An object describing the result of your get relational database log events
	// request.
	ResourceLogEvents []types.LogEvent

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseLogStreamsInput 

type GetRelationalDatabaseLogStreamsInput struct {

	// The name of your database for which to get log streams.
	//
	// This member is required.
	RelationalDatabaseName *string
}

type GetRelationalDatabaseLogStreamsOutput 

type GetRelationalDatabaseLogStreamsOutput struct {

	// An object describing the result of your get relational database log streams
	// request.
	LogStreams []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseMasterUserPasswordInput 

type GetRelationalDatabaseMasterUserPasswordInput struct {

	// The name of your database for which to get the master user password.
	//
	// This member is required.
	RelationalDatabaseName *string

	// 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
	PasswordVersion types.RelationalDatabasePasswordVersion
}

type GetRelationalDatabaseMasterUserPasswordOutput 

type GetRelationalDatabaseMasterUserPasswordOutput struct {

	// The timestamp when the specified version of the master user password was
	// created.
	CreatedAt *time.Time

	// The master user password for the password version specified.
	MasterUserPassword *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseMetricDataInput 

type GetRelationalDatabaseMetricDataInput struct {

	// 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.
	//
	// This member is required.
	EndTime *time.Time

	// 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.
	//
	// This member is required.
	MetricName types.RelationalDatabaseMetricName

	// The granularity, in seconds, of the returned data points. All relational
	// database metric data is available in 1-minute (60 seconds) granularity.
	//
	// This member is required.
	Period int32

	// The name of your database from which to get metric data.
	//
	// This member is required.
	RelationalDatabaseName *string

	// 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.
	//
	// This member is required.
	StartTime *time.Time

	// 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.
	//
	// This member is required.
	Statistics []types.MetricStatistic

	// 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.
	//
	// This member is required.
	Unit types.MetricUnit
}

type GetRelationalDatabaseMetricDataOutput 

type GetRelationalDatabaseMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []types.MetricDatapoint

	// The name of the metric returned.
	MetricName types.RelationalDatabaseMetricName

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseOutput 

type GetRelationalDatabaseOutput struct {

	// An object describing the specified database.
	RelationalDatabase *types.RelationalDatabase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseParametersInput 

type GetRelationalDatabaseParametersInput struct {

	// The name of your database for which to get parameters.
	//
	// This member is required.
	RelationalDatabaseName *string

	// 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.
	PageToken *string
}

type GetRelationalDatabaseParametersOutput 

type GetRelationalDatabaseParametersOutput struct {

	// 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.
	NextPageToken *string

	// An object describing the result of your get relational database parameters
	// request.
	Parameters []types.RelationalDatabaseParameter

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseSnapshotInput 

type GetRelationalDatabaseSnapshotInput struct {

	// The name of the database snapshot for which to get information.
	//
	// This member is required.
	RelationalDatabaseSnapshotName *string
}

type GetRelationalDatabaseSnapshotOutput 

type GetRelationalDatabaseSnapshotOutput struct {

	// An object describing the specified database snapshot.
	RelationalDatabaseSnapshot *types.RelationalDatabaseSnapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabaseSnapshotsInput 

type GetRelationalDatabaseSnapshotsInput struct {

	// 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.
	PageToken *string
}

type GetRelationalDatabaseSnapshotsOutput 

type GetRelationalDatabaseSnapshotsOutput struct {

	// 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.
	NextPageToken *string

	// An object describing the result of your get relational database snapshots
	// request.
	RelationalDatabaseSnapshots []types.RelationalDatabaseSnapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRelationalDatabasesInput 

type GetRelationalDatabasesInput struct {

	// 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.
	PageToken *string
}

type GetRelationalDatabasesOutput 

type GetRelationalDatabasesOutput struct {

	// 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.
	NextPageToken *string

	// An object describing the result of your get relational databases request.
	RelationalDatabases []types.RelationalDatabase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetStaticIpInput 

type GetStaticIpInput struct {

	// The name of the static IP in Lightsail.
	//
	// This member is required.
	StaticIpName *string
}

type GetStaticIpOutput 

type GetStaticIpOutput struct {

	// An array of key-value pairs containing information about the requested static
	// IP.
	StaticIp *types.StaticIp

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetStaticIpsInput 

type GetStaticIpsInput struct {

	// 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.
	PageToken *string
}

type GetStaticIpsOutput 

type GetStaticIpsOutput struct {

	// 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.
	NextPageToken *string

	// An array of key-value pairs containing information about your get static IPs
	// request.
	StaticIps []types.StaticIp

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ImportKeyPairInput 

type ImportKeyPairInput struct {

	// The name of the key pair for which you want to import the public key.
	//
	// This member is required.
	KeyPairName *string

	// A base64-encoded public key of the ssh-rsa type.
	//
	// This member is required.
	PublicKeyBase64 *string
}

type ImportKeyPairOutput 

type ImportKeyPairOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type IsVpcPeeredInput 

type IsVpcPeeredInput struct {
}

type IsVpcPeeredOutput 

type IsVpcPeeredOutput struct {

	// Returns true if the Lightsail VPC is peered; otherwise, false.
	IsPeered *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type OpenInstancePublicPortsInput 

type OpenInstancePublicPortsInput struct {

	// The name of the instance for which to open ports.
	//
	// This member is required.
	InstanceName *string

	// An object to describe the ports to open for the specified instance.
	//
	// This member is required.
	PortInfo *types.PortInfo
}

type OpenInstancePublicPortsOutput 

type OpenInstancePublicPortsOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PeerVpcInput 

type PeerVpcInput struct {
}

type PeerVpcOutput 

type PeerVpcOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutAlarmInput 

type PutAlarmInput struct {

	// The name for the alarm. Specify the name of an existing alarm to update, and
	// overwrite the previous configuration of the alarm.
	//
	// This member is required.
	AlarmName *string

	// The arithmetic operation to use when comparing the specified statistic to the
	// threshold. The specified statistic value is used as the first operand.
	//
	// This member is required.
	ComparisonOperator types.ComparisonOperator

	// 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).
	//
	// This member is required.
	EvaluationPeriods *int32

	// 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
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics).
	//
	// This member is required.
	MetricName types.MetricName

	// 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.
	//
	// This member is required.
	MonitoredResourceName *string

	// The value against which the specified statistic is compared.
	//
	// This member is required.
	Threshold *float64

	// 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 AWS 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 AWS Region.
	ContactProtocols []types.ContactProtocol

	// 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.
	DatapointsToAlarm *int32

	// Indicates whether the alarm is enabled. Notifications are enabled by default if
	// you don't specify this parameter.
	NotificationEnabled *bool

	// 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.
	NotificationTriggers []types.AlarmState

	// 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.
	TreatMissingData types.TreatMissingData
}

type PutAlarmOutput 

type PutAlarmOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutInstancePublicPortsInput 

type PutInstancePublicPortsInput struct {

	// The name of the instance for which to open ports.
	//
	// This member is required.
	InstanceName *string

	// An array of objects to describe the ports to open for the specified instance.
	//
	// This member is required.
	PortInfos []types.PortInfo
}

type PutInstancePublicPortsOutput 

type PutInstancePublicPortsOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RebootInstanceInput 

type RebootInstanceInput struct {

	// The name of the instance to reboot.
	//
	// This member is required.
	InstanceName *string
}

type RebootInstanceOutput 

type RebootInstanceOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RebootRelationalDatabaseInput 

type RebootRelationalDatabaseInput struct {

	// The name of your database to reboot.
	//
	// This member is required.
	RelationalDatabaseName *string
}

type RebootRelationalDatabaseOutput 

type RebootRelationalDatabaseOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RegisterContainerImageInput added in v0.30.0 

type RegisterContainerImageInput struct {

	// The digest of the container image to be registered.
	//
	// This member is required.
	Digest *string

	// The label for the container image when it's registered to the container service.
	// Use a descriptive label that you can use to track the different versions of your
	// registered container images. Use the GetContainerImages action to return the
	// container images registered to a Lightsail container service. The label is the
	// portion of the following image name example:
	//
	// * :container-service-1..1
	//
	// If the
	// name of your container service is mycontainerservice, and the label that you
	// specify is mystaticwebsite, then the name of the registered container image will
	// be :mycontainerservice.mystaticwebsite.1. The number at the end of these image
	// name examples represents the version of the registered container image. If you
	// push and register another container image to the same Lightsail container
	// service, with the same label, then the version number for the new registered
	// container image will be 2. If you push and register another container image, the
	// version number will be 3, and so on.
	//
	// This member is required.
	Label *string

	// The name of the container service for which to register a container image.
	//
	// This member is required.
	ServiceName *string
}

type RegisterContainerImageOutput added in v0.30.0 

type RegisterContainerImageOutput struct {

	// Describes a container image that is registered to an Amazon Lightsail container
	// service.
	ContainerImage *types.ContainerImage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ReleaseStaticIpInput 

type ReleaseStaticIpInput struct {

	// The name of the static IP to delete.
	//
	// This member is required.
	StaticIpName *string
}

type ReleaseStaticIpOutput 

type ReleaseStaticIpOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResetDistributionCacheInput 

type ResetDistributionCacheInput struct {

	// 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.
	DistributionName *string
}

type ResetDistributionCacheOutput 

type ResetDistributionCacheOutput struct {

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

	// 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.
	Operation *types.Operation

	// The status of the reset cache request.
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SendContactMethodVerificationInput 

type SendContactMethodVerificationInput struct {

	// The protocol to verify, such as Email or SMS (text messaging).
	//
	// This member is required.
	Protocol types.ContactMethodVerificationProtocol
}

type SendContactMethodVerificationOutput 

type SendContactMethodVerificationOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetIpAddressTypeInput added in v1.2.0 

type SetIpAddressTypeInput struct {

	// The IP address type to set for the specified resource. The possible values are
	// ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	//
	// This member is required.
	IpAddressType types.IpAddressType

	// The name of the resource for which to set the IP address type.
	//
	// This member is required.
	ResourceName *string

	// The resource type. The possible values are Distribution, Instance, and
	// LoadBalancer. Distribution-related APIs are available only in the N. Virginia
	// (us-east-1) AWS Region. Set your AWS Region configuration to us-east-1 to
	// create, view, or edit distributions.
	//
	// This member is required.
	ResourceType types.ResourceType
}

type SetIpAddressTypeOutput added in v1.2.0 

type SetIpAddressTypeOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartInstanceInput 

type StartInstanceInput struct {

	// The name of the instance (a virtual private server) to start.
	//
	// This member is required.
	InstanceName *string
}

type StartInstanceOutput 

type StartInstanceOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartRelationalDatabaseInput 

type StartRelationalDatabaseInput struct {

	// The name of your database to start.
	//
	// This member is required.
	RelationalDatabaseName *string
}

type StartRelationalDatabaseOutput 

type StartRelationalDatabaseOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopInstanceInput 

type StopInstanceInput struct {

	// The name of the instance (a virtual private server) to stop.
	//
	// This member is required.
	InstanceName *string

	// 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.
	Force *bool
}

type StopInstanceOutput 

type StopInstanceOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopRelationalDatabaseInput 

type StopRelationalDatabaseInput struct {

	// The name of your database to stop.
	//
	// This member is required.
	RelationalDatabaseName *string

	// The name of your new database snapshot to be created before stopping your
	// database.
	RelationalDatabaseSnapshotName *string
}

type StopRelationalDatabaseOutput 

type StopRelationalDatabaseOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput 

type TagResourceInput struct {

	// The name of the resource to which you are adding tags.
	//
	// This member is required.
	ResourceName *string

	// The tag key and optional value.
	//
	// This member is required.
	Tags []types.Tag

	// The Amazon Resource Name (ARN) of the resource to which you want to add a tag.
	ResourceArn *string
}

type TagResourceOutput 

type TagResourceOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TestAlarmInput 

type TestAlarmInput struct {

	// The name of the alarm to test.
	//
	// This member is required.
	AlarmName *string

	// 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.
	//
	// This member is required.
	State types.AlarmState
}

type TestAlarmOutput 

type TestAlarmOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UnpeerVpcInput 

type UnpeerVpcInput struct {
}

type UnpeerVpcOutput 

type UnpeerVpcOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The name of the resource from which you are removing a tag.
	//
	// This member is required.
	ResourceName *string

	// The tag keys to delete from the specified resource.
	//
	// This member is required.
	TagKeys []string

	// The Amazon Resource Name (ARN) of the resource from which you want to remove a
	// tag.
	ResourceArn *string
}

type UntagResourceOutput 

type UntagResourceOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateContainerServiceInput added in v0.30.0 

type UpdateContainerServiceInput struct {

	// The name of the container service to update.
	//
	// This member is required.
	ServiceName *string

	// A Boolean value to indicate whether the container service is disabled.
	IsDisabled *bool

	// 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.
	Power types.ContainerServicePowerName

	// 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.
	PublicDomainNames map[string][]string

	// 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.
	Scale *int32
}

type UpdateContainerServiceOutput added in v0.30.0 

type UpdateContainerServiceOutput struct {

	// An object that describes a container service.
	ContainerService *types.ContainerService

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDistributionBundleInput 

type UpdateDistributionBundleInput struct {

	// 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.
	BundleId *string

	// 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.
	DistributionName *string
}

type UpdateDistributionBundleOutput 

type UpdateDistributionBundleOutput struct {

	// Describes the API operation.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDistributionInput 

type UpdateDistributionInput struct {

	// The name of the distribution to update. Use the GetDistributions action to get a
	// list of distribution names that you can specify.
	//
	// This member is required.
	DistributionName *string

	// An object that describes the cache behavior settings for the distribution. The
	// cacheBehaviorSettings specified in your UpdateDistributionRequest will replace
	// your distribution's existing settings.
	CacheBehaviorSettings *types.CacheSettings

	// An array of objects that describe the per-path cache behavior for the
	// distribution.
	CacheBehaviors []types.CacheBehaviorPerPath

	// An object that describes the default cache behavior for the distribution.
	DefaultCacheBehavior *types.CacheBehavior

	// Indicates whether to enable the distribution.
	IsEnabled *bool

	// An object that describes the origin resource for the distribution, such as a
	// Lightsail instance or load balancer. The distribution pulls, caches, and serves
	// content from the origin.
	Origin *types.InputOrigin
}

type UpdateDistributionOutput 

type UpdateDistributionOutput struct {

	// 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.
	Operation *types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDomainEntryInput 

type UpdateDomainEntryInput struct {

	// An array of key-value pairs containing information about the domain entry.
	//
	// This member is required.
	DomainEntry *types.DomainEntry

	// The name of the domain recordset to update.
	//
	// This member is required.
	DomainName *string
}

type UpdateDomainEntryOutput 

type UpdateDomainEntryOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateLoadBalancerAttributeInput 

type UpdateLoadBalancerAttributeInput struct {

	// The name of the attribute you want to update. Valid values are below.
	//
	// This member is required.
	AttributeName types.LoadBalancerAttributeName

	// The value that you want to specify for the attribute name.
	//
	// This member is required.
	AttributeValue *string

	// The name of the load balancer that you want to modify (e.g., my-load-balancer.
	//
	// This member is required.
	LoadBalancerName *string
}

type UpdateLoadBalancerAttributeOutput 

type UpdateLoadBalancerAttributeOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRelationalDatabaseInput 

type UpdateRelationalDatabaseInput struct {

	// The name of your database to update.
	//
	// This member is required.
	RelationalDatabaseName *string

	// When true, applies changes immediately. When false, applies changes during the
	// preferred maintenance window. Some changes may cause an outage. Default: false
	ApplyImmediately *bool

	// Indicates the certificate that needs to be associated with the database.
	CaCertificateIdentifier *string

	// 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.
	DisableBackupRetention *bool

	// When true, enables automated backup retention for your database. Updates are
	// applied during the next maintenance window because this can result in an outage.
	EnableBackupRetention *bool

	// The password for the master user of your database. The password can include any
	// printable ASCII character except "/", """, or "@". Constraints: Must contain 8
	// to 41 characters.
	MasterUserPassword *string

	// 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.
	PreferredBackupWindow *string

	// 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 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
	PreferredMaintenanceWindow *string

	// 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.
	PubliclyAccessible *bool

	// 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.
	RotateMasterUserPassword *bool
}

type UpdateRelationalDatabaseOutput 

type UpdateRelationalDatabaseOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRelationalDatabaseParametersInput 

type UpdateRelationalDatabaseParametersInput struct {

	// The database parameters to update.
	//
	// This member is required.
	Parameters []types.RelationalDatabaseParameter

	// The name of your database for which to update parameters.
	//
	// This member is required.
	RelationalDatabaseName *string
}

type UpdateRelationalDatabaseParametersOutput 

type UpdateRelationalDatabaseParametersOutput struct {

	// 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.
	Operations []types.Operation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.