lightsail

package
v1.99.1 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package lightsail provides the client and types for making API requests to Amazon Lightsail.

Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, a managed database, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).

For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/all).

To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, 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).

See https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28 for more information on this service.

See lightsail package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/lightsail/

Using the Client

To contact Amazon Lightsail with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Lightsail client Lightsail for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/lightsail/#New

Index

Constants

View Source
const (
	// AccessDirectionInbound is a AccessDirection enum value
	AccessDirectionInbound = "inbound"

	// AccessDirectionOutbound is a AccessDirection enum value
	AccessDirectionOutbound = "outbound"
)
View Source
const (
	// BlueprintTypeOs is a BlueprintType enum value
	BlueprintTypeOs = "os"

	// BlueprintTypeApp is a BlueprintType enum value
	BlueprintTypeApp = "app"
)
View Source
const (
	// DiskSnapshotStatePending is a DiskSnapshotState enum value
	DiskSnapshotStatePending = "pending"

	// DiskSnapshotStateCompleted is a DiskSnapshotState enum value
	DiskSnapshotStateCompleted = "completed"

	// DiskSnapshotStateError is a DiskSnapshotState enum value
	DiskSnapshotStateError = "error"

	// DiskSnapshotStateUnknown is a DiskSnapshotState enum value
	DiskSnapshotStateUnknown = "unknown"
)
View Source
const (
	// DiskStatePending is a DiskState enum value
	DiskStatePending = "pending"

	// DiskStateError is a DiskState enum value
	DiskStateError = "error"

	// DiskStateAvailable is a DiskState enum value
	DiskStateAvailable = "available"

	// DiskStateInUse is a DiskState enum value
	DiskStateInUse = "in-use"

	// DiskStateUnknown is a DiskState enum value
	DiskStateUnknown = "unknown"
)
View Source
const (
	// ExportSnapshotRecordSourceTypeInstanceSnapshot is a ExportSnapshotRecordSourceType enum value
	ExportSnapshotRecordSourceTypeInstanceSnapshot = "InstanceSnapshot"

	// ExportSnapshotRecordSourceTypeDiskSnapshot is a ExportSnapshotRecordSourceType enum value
	ExportSnapshotRecordSourceTypeDiskSnapshot = "DiskSnapshot"
)
View Source
const (
	// InstanceAccessProtocolSsh is a InstanceAccessProtocol enum value
	InstanceAccessProtocolSsh = "ssh"

	// InstanceAccessProtocolRdp is a InstanceAccessProtocol enum value
	InstanceAccessProtocolRdp = "rdp"
)
View Source
const (
	// InstanceHealthReasonLbRegistrationInProgress is a InstanceHealthReason enum value
	InstanceHealthReasonLbRegistrationInProgress = "Lb.RegistrationInProgress"

	// InstanceHealthReasonLbInitialHealthChecking is a InstanceHealthReason enum value
	InstanceHealthReasonLbInitialHealthChecking = "Lb.InitialHealthChecking"

	// InstanceHealthReasonLbInternalError is a InstanceHealthReason enum value
	InstanceHealthReasonLbInternalError = "Lb.InternalError"

	// InstanceHealthReasonInstanceResponseCodeMismatch is a InstanceHealthReason enum value
	InstanceHealthReasonInstanceResponseCodeMismatch = "Instance.ResponseCodeMismatch"

	// InstanceHealthReasonInstanceTimeout is a InstanceHealthReason enum value
	InstanceHealthReasonInstanceTimeout = "Instance.Timeout"

	// InstanceHealthReasonInstanceFailedHealthChecks is a InstanceHealthReason enum value
	InstanceHealthReasonInstanceFailedHealthChecks = "Instance.FailedHealthChecks"

	// InstanceHealthReasonInstanceNotRegistered is a InstanceHealthReason enum value
	InstanceHealthReasonInstanceNotRegistered = "Instance.NotRegistered"

	// InstanceHealthReasonInstanceNotInUse is a InstanceHealthReason enum value
	InstanceHealthReasonInstanceNotInUse = "Instance.NotInUse"

	// InstanceHealthReasonInstanceDeregistrationInProgress is a InstanceHealthReason enum value
	InstanceHealthReasonInstanceDeregistrationInProgress = "Instance.DeregistrationInProgress"

	// InstanceHealthReasonInstanceInvalidState is a InstanceHealthReason enum value
	InstanceHealthReasonInstanceInvalidState = "Instance.InvalidState"

	// InstanceHealthReasonInstanceIpUnusable is a InstanceHealthReason enum value
	InstanceHealthReasonInstanceIpUnusable = "Instance.IpUnusable"
)
View Source
const (
	// InstanceHealthStateInitial is a InstanceHealthState enum value
	InstanceHealthStateInitial = "initial"

	// InstanceHealthStateHealthy is a InstanceHealthState enum value
	InstanceHealthStateHealthy = "healthy"

	// InstanceHealthStateUnhealthy is a InstanceHealthState enum value
	InstanceHealthStateUnhealthy = "unhealthy"

	// InstanceHealthStateUnused is a InstanceHealthState enum value
	InstanceHealthStateUnused = "unused"

	// InstanceHealthStateDraining is a InstanceHealthState enum value
	InstanceHealthStateDraining = "draining"

	// InstanceHealthStateUnavailable is a InstanceHealthState enum value
	InstanceHealthStateUnavailable = "unavailable"
)
View Source
const (
	// InstanceMetricNameCpuutilization is a InstanceMetricName enum value
	InstanceMetricNameCpuutilization = "CPUUtilization"

	// InstanceMetricNameNetworkIn is a InstanceMetricName enum value
	InstanceMetricNameNetworkIn = "NetworkIn"

	// InstanceMetricNameNetworkOut is a InstanceMetricName enum value
	InstanceMetricNameNetworkOut = "NetworkOut"

	// InstanceMetricNameStatusCheckFailed is a InstanceMetricName enum value
	InstanceMetricNameStatusCheckFailed = "StatusCheckFailed"

	// InstanceMetricNameStatusCheckFailedInstance is a InstanceMetricName enum value
	InstanceMetricNameStatusCheckFailedInstance = "StatusCheckFailed_Instance"

	// InstanceMetricNameStatusCheckFailedSystem is a InstanceMetricName enum value
	InstanceMetricNameStatusCheckFailedSystem = "StatusCheckFailed_System"
)
View Source
const (
	// InstancePlatformLinuxUnix is a InstancePlatform enum value
	InstancePlatformLinuxUnix = "LINUX_UNIX"

	// InstancePlatformWindows is a InstancePlatform enum value
	InstancePlatformWindows = "WINDOWS"
)
View Source
const (
	// InstanceSnapshotStatePending is a InstanceSnapshotState enum value
	InstanceSnapshotStatePending = "pending"

	// InstanceSnapshotStateError is a InstanceSnapshotState enum value
	InstanceSnapshotStateError = "error"

	// InstanceSnapshotStateAvailable is a InstanceSnapshotState enum value
	InstanceSnapshotStateAvailable = "available"
)
View Source
const (
	// LoadBalancerAttributeNameHealthCheckPath is a LoadBalancerAttributeName enum value
	LoadBalancerAttributeNameHealthCheckPath = "HealthCheckPath"

	// LoadBalancerAttributeNameSessionStickinessEnabled is a LoadBalancerAttributeName enum value
	LoadBalancerAttributeNameSessionStickinessEnabled = "SessionStickinessEnabled"

	// LoadBalancerAttributeNameSessionStickinessLbCookieDurationSeconds is a LoadBalancerAttributeName enum value
	LoadBalancerAttributeNameSessionStickinessLbCookieDurationSeconds = "SessionStickiness_LB_CookieDurationSeconds"
)
View Source
const (
	// LoadBalancerMetricNameClientTlsnegotiationErrorCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameClientTlsnegotiationErrorCount = "ClientTLSNegotiationErrorCount"

	// LoadBalancerMetricNameHealthyHostCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameHealthyHostCount = "HealthyHostCount"

	// LoadBalancerMetricNameUnhealthyHostCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameUnhealthyHostCount = "UnhealthyHostCount"

	// LoadBalancerMetricNameHttpcodeLb4xxCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameHttpcodeLb4xxCount = "HTTPCode_LB_4XX_Count"

	// LoadBalancerMetricNameHttpcodeLb5xxCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameHttpcodeLb5xxCount = "HTTPCode_LB_5XX_Count"

	// LoadBalancerMetricNameHttpcodeInstance2xxCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameHttpcodeInstance2xxCount = "HTTPCode_Instance_2XX_Count"

	// LoadBalancerMetricNameHttpcodeInstance3xxCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameHttpcodeInstance3xxCount = "HTTPCode_Instance_3XX_Count"

	// LoadBalancerMetricNameHttpcodeInstance4xxCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameHttpcodeInstance4xxCount = "HTTPCode_Instance_4XX_Count"

	// LoadBalancerMetricNameHttpcodeInstance5xxCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameHttpcodeInstance5xxCount = "HTTPCode_Instance_5XX_Count"

	// LoadBalancerMetricNameInstanceResponseTime is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameInstanceResponseTime = "InstanceResponseTime"

	// LoadBalancerMetricNameRejectedConnectionCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameRejectedConnectionCount = "RejectedConnectionCount"

	// LoadBalancerMetricNameRequestCount is a LoadBalancerMetricName enum value
	LoadBalancerMetricNameRequestCount = "RequestCount"
)
View Source
const (
	// LoadBalancerProtocolHttpHttps is a LoadBalancerProtocol enum value
	LoadBalancerProtocolHttpHttps = "HTTP_HTTPS"

	// LoadBalancerProtocolHttp is a LoadBalancerProtocol enum value
	LoadBalancerProtocolHttp = "HTTP"
)
View Source
const (
	// LoadBalancerStateActive is a LoadBalancerState enum value
	LoadBalancerStateActive = "active"

	// LoadBalancerStateProvisioning is a LoadBalancerState enum value
	LoadBalancerStateProvisioning = "provisioning"

	// LoadBalancerStateActiveImpaired is a LoadBalancerState enum value
	LoadBalancerStateActiveImpaired = "active_impaired"

	// LoadBalancerStateFailed is a LoadBalancerState enum value
	LoadBalancerStateFailed = "failed"

	// LoadBalancerStateUnknown is a LoadBalancerState enum value
	LoadBalancerStateUnknown = "unknown"
)
View Source
const (
	// LoadBalancerTlsCertificateDomainStatusPendingValidation is a LoadBalancerTlsCertificateDomainStatus enum value
	LoadBalancerTlsCertificateDomainStatusPendingValidation = "PENDING_VALIDATION"

	// LoadBalancerTlsCertificateDomainStatusFailed is a LoadBalancerTlsCertificateDomainStatus enum value
	LoadBalancerTlsCertificateDomainStatusFailed = "FAILED"

	// LoadBalancerTlsCertificateDomainStatusSuccess is a LoadBalancerTlsCertificateDomainStatus enum value
	LoadBalancerTlsCertificateDomainStatusSuccess = "SUCCESS"
)
View Source
const (
	// LoadBalancerTlsCertificateFailureReasonNoAvailableContacts is a LoadBalancerTlsCertificateFailureReason enum value
	LoadBalancerTlsCertificateFailureReasonNoAvailableContacts = "NO_AVAILABLE_CONTACTS"

	// LoadBalancerTlsCertificateFailureReasonAdditionalVerificationRequired is a LoadBalancerTlsCertificateFailureReason enum value
	LoadBalancerTlsCertificateFailureReasonAdditionalVerificationRequired = "ADDITIONAL_VERIFICATION_REQUIRED"

	// LoadBalancerTlsCertificateFailureReasonDomainNotAllowed is a LoadBalancerTlsCertificateFailureReason enum value
	LoadBalancerTlsCertificateFailureReasonDomainNotAllowed = "DOMAIN_NOT_ALLOWED"

	// LoadBalancerTlsCertificateFailureReasonInvalidPublicDomain is a LoadBalancerTlsCertificateFailureReason enum value
	LoadBalancerTlsCertificateFailureReasonInvalidPublicDomain = "INVALID_PUBLIC_DOMAIN"

	// LoadBalancerTlsCertificateFailureReasonOther is a LoadBalancerTlsCertificateFailureReason enum value
	LoadBalancerTlsCertificateFailureReasonOther = "OTHER"
)
View Source
const (
	// LoadBalancerTlsCertificateRenewalStatusPendingAutoRenewal is a LoadBalancerTlsCertificateRenewalStatus enum value
	LoadBalancerTlsCertificateRenewalStatusPendingAutoRenewal = "PENDING_AUTO_RENEWAL"

	// LoadBalancerTlsCertificateRenewalStatusPendingValidation is a LoadBalancerTlsCertificateRenewalStatus enum value
	LoadBalancerTlsCertificateRenewalStatusPendingValidation = "PENDING_VALIDATION"

	// LoadBalancerTlsCertificateRenewalStatusSuccess is a LoadBalancerTlsCertificateRenewalStatus enum value
	LoadBalancerTlsCertificateRenewalStatusSuccess = "SUCCESS"

	// LoadBalancerTlsCertificateRenewalStatusFailed is a LoadBalancerTlsCertificateRenewalStatus enum value
	LoadBalancerTlsCertificateRenewalStatusFailed = "FAILED"
)
View Source
const (
	// LoadBalancerTlsCertificateRevocationReasonUnspecified is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonUnspecified = "UNSPECIFIED"

	// LoadBalancerTlsCertificateRevocationReasonKeyCompromise is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonKeyCompromise = "KEY_COMPROMISE"

	// LoadBalancerTlsCertificateRevocationReasonCaCompromise is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonCaCompromise = "CA_COMPROMISE"

	// LoadBalancerTlsCertificateRevocationReasonAffiliationChanged is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonAffiliationChanged = "AFFILIATION_CHANGED"

	// LoadBalancerTlsCertificateRevocationReasonSuperceded is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonSuperceded = "SUPERCEDED"

	// LoadBalancerTlsCertificateRevocationReasonCessationOfOperation is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonCessationOfOperation = "CESSATION_OF_OPERATION"

	// LoadBalancerTlsCertificateRevocationReasonCertificateHold is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonCertificateHold = "CERTIFICATE_HOLD"

	// LoadBalancerTlsCertificateRevocationReasonRemoveFromCrl is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonRemoveFromCrl = "REMOVE_FROM_CRL"

	// LoadBalancerTlsCertificateRevocationReasonPrivilegeWithdrawn is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonPrivilegeWithdrawn = "PRIVILEGE_WITHDRAWN"

	// LoadBalancerTlsCertificateRevocationReasonAACompromise is a LoadBalancerTlsCertificateRevocationReason enum value
	LoadBalancerTlsCertificateRevocationReasonAACompromise = "A_A_COMPROMISE"
)
View Source
const (
	// LoadBalancerTlsCertificateStatusPendingValidation is a LoadBalancerTlsCertificateStatus enum value
	LoadBalancerTlsCertificateStatusPendingValidation = "PENDING_VALIDATION"

	// LoadBalancerTlsCertificateStatusIssued is a LoadBalancerTlsCertificateStatus enum value
	LoadBalancerTlsCertificateStatusIssued = "ISSUED"

	// LoadBalancerTlsCertificateStatusInactive is a LoadBalancerTlsCertificateStatus enum value
	LoadBalancerTlsCertificateStatusInactive = "INACTIVE"

	// LoadBalancerTlsCertificateStatusExpired is a LoadBalancerTlsCertificateStatus enum value
	LoadBalancerTlsCertificateStatusExpired = "EXPIRED"

	// LoadBalancerTlsCertificateStatusValidationTimedOut is a LoadBalancerTlsCertificateStatus enum value
	LoadBalancerTlsCertificateStatusValidationTimedOut = "VALIDATION_TIMED_OUT"

	// LoadBalancerTlsCertificateStatusRevoked is a LoadBalancerTlsCertificateStatus enum value
	LoadBalancerTlsCertificateStatusRevoked = "REVOKED"

	// LoadBalancerTlsCertificateStatusFailed is a LoadBalancerTlsCertificateStatus enum value
	LoadBalancerTlsCertificateStatusFailed = "FAILED"

	// LoadBalancerTlsCertificateStatusUnknown is a LoadBalancerTlsCertificateStatus enum value
	LoadBalancerTlsCertificateStatusUnknown = "UNKNOWN"
)
View Source
const (
	// MetricStatisticMinimum is a MetricStatistic enum value
	MetricStatisticMinimum = "Minimum"

	// MetricStatisticMaximum is a MetricStatistic enum value
	MetricStatisticMaximum = "Maximum"

	// MetricStatisticSum is a MetricStatistic enum value
	MetricStatisticSum = "Sum"

	// MetricStatisticAverage is a MetricStatistic enum value
	MetricStatisticAverage = "Average"

	// MetricStatisticSampleCount is a MetricStatistic enum value
	MetricStatisticSampleCount = "SampleCount"
)
View Source
const (
	// MetricUnitSeconds is a MetricUnit enum value
	MetricUnitSeconds = "Seconds"

	// MetricUnitMicroseconds is a MetricUnit enum value
	MetricUnitMicroseconds = "Microseconds"

	// MetricUnitMilliseconds is a MetricUnit enum value
	MetricUnitMilliseconds = "Milliseconds"

	// MetricUnitBytes is a MetricUnit enum value
	MetricUnitBytes = "Bytes"

	// MetricUnitKilobytes is a MetricUnit enum value
	MetricUnitKilobytes = "Kilobytes"

	// MetricUnitMegabytes is a MetricUnit enum value
	MetricUnitMegabytes = "Megabytes"

	// MetricUnitGigabytes is a MetricUnit enum value
	MetricUnitGigabytes = "Gigabytes"

	// MetricUnitTerabytes is a MetricUnit enum value
	MetricUnitTerabytes = "Terabytes"

	// MetricUnitBits is a MetricUnit enum value
	MetricUnitBits = "Bits"

	// MetricUnitKilobits is a MetricUnit enum value
	MetricUnitKilobits = "Kilobits"

	// MetricUnitMegabits is a MetricUnit enum value
	MetricUnitMegabits = "Megabits"

	// MetricUnitGigabits is a MetricUnit enum value
	MetricUnitGigabits = "Gigabits"

	// MetricUnitTerabits is a MetricUnit enum value
	MetricUnitTerabits = "Terabits"

	// MetricUnitPercent is a MetricUnit enum value
	MetricUnitPercent = "Percent"

	// MetricUnitCount is a MetricUnit enum value
	MetricUnitCount = "Count"

	// MetricUnitBytesSecond is a MetricUnit enum value
	MetricUnitBytesSecond = "Bytes/Second"

	// MetricUnitKilobytesSecond is a MetricUnit enum value
	MetricUnitKilobytesSecond = "Kilobytes/Second"

	// MetricUnitMegabytesSecond is a MetricUnit enum value
	MetricUnitMegabytesSecond = "Megabytes/Second"

	// MetricUnitGigabytesSecond is a MetricUnit enum value
	MetricUnitGigabytesSecond = "Gigabytes/Second"

	// MetricUnitTerabytesSecond is a MetricUnit enum value
	MetricUnitTerabytesSecond = "Terabytes/Second"

	// MetricUnitBitsSecond is a MetricUnit enum value
	MetricUnitBitsSecond = "Bits/Second"

	// MetricUnitKilobitsSecond is a MetricUnit enum value
	MetricUnitKilobitsSecond = "Kilobits/Second"

	// MetricUnitMegabitsSecond is a MetricUnit enum value
	MetricUnitMegabitsSecond = "Megabits/Second"

	// MetricUnitGigabitsSecond is a MetricUnit enum value
	MetricUnitGigabitsSecond = "Gigabits/Second"

	// MetricUnitTerabitsSecond is a MetricUnit enum value
	MetricUnitTerabitsSecond = "Terabits/Second"

	// MetricUnitCountSecond is a MetricUnit enum value
	MetricUnitCountSecond = "Count/Second"

	// MetricUnitNone is a MetricUnit enum value
	MetricUnitNone = "None"
)
View Source
const (
	// NetworkProtocolTcp is a NetworkProtocol enum value
	NetworkProtocolTcp = "tcp"

	// NetworkProtocolAll is a NetworkProtocol enum value
	NetworkProtocolAll = "all"

	// NetworkProtocolUdp is a NetworkProtocol enum value
	NetworkProtocolUdp = "udp"
)
View Source
const (
	// OperationStatusNotStarted is a OperationStatus enum value
	OperationStatusNotStarted = "NotStarted"

	// OperationStatusStarted is a OperationStatus enum value
	OperationStatusStarted = "Started"

	// OperationStatusFailed is a OperationStatus enum value
	OperationStatusFailed = "Failed"

	// OperationStatusCompleted is a OperationStatus enum value
	OperationStatusCompleted = "Completed"

	// OperationStatusSucceeded is a OperationStatus enum value
	OperationStatusSucceeded = "Succeeded"
)
View Source
const (
	// OperationTypeDeleteKnownHostKeys is a OperationType enum value
	OperationTypeDeleteKnownHostKeys = "DeleteKnownHostKeys"

	// OperationTypeDeleteInstance is a OperationType enum value
	OperationTypeDeleteInstance = "DeleteInstance"

	// OperationTypeCreateInstance is a OperationType enum value
	OperationTypeCreateInstance = "CreateInstance"

	// OperationTypeStopInstance is a OperationType enum value
	OperationTypeStopInstance = "StopInstance"

	// OperationTypeStartInstance is a OperationType enum value
	OperationTypeStartInstance = "StartInstance"

	// OperationTypeRebootInstance is a OperationType enum value
	OperationTypeRebootInstance = "RebootInstance"

	// OperationTypeOpenInstancePublicPorts is a OperationType enum value
	OperationTypeOpenInstancePublicPorts = "OpenInstancePublicPorts"

	// OperationTypePutInstancePublicPorts is a OperationType enum value
	OperationTypePutInstancePublicPorts = "PutInstancePublicPorts"

	// OperationTypeCloseInstancePublicPorts is a OperationType enum value
	OperationTypeCloseInstancePublicPorts = "CloseInstancePublicPorts"

	// OperationTypeAllocateStaticIp is a OperationType enum value
	OperationTypeAllocateStaticIp = "AllocateStaticIp"

	// OperationTypeReleaseStaticIp is a OperationType enum value
	OperationTypeReleaseStaticIp = "ReleaseStaticIp"

	// OperationTypeAttachStaticIp is a OperationType enum value
	OperationTypeAttachStaticIp = "AttachStaticIp"

	// OperationTypeDetachStaticIp is a OperationType enum value
	OperationTypeDetachStaticIp = "DetachStaticIp"

	// OperationTypeUpdateDomainEntry is a OperationType enum value
	OperationTypeUpdateDomainEntry = "UpdateDomainEntry"

	// OperationTypeDeleteDomainEntry is a OperationType enum value
	OperationTypeDeleteDomainEntry = "DeleteDomainEntry"

	// OperationTypeCreateDomain is a OperationType enum value
	OperationTypeCreateDomain = "CreateDomain"

	// OperationTypeDeleteDomain is a OperationType enum value
	OperationTypeDeleteDomain = "DeleteDomain"

	// OperationTypeCreateInstanceSnapshot is a OperationType enum value
	OperationTypeCreateInstanceSnapshot = "CreateInstanceSnapshot"

	// OperationTypeDeleteInstanceSnapshot is a OperationType enum value
	OperationTypeDeleteInstanceSnapshot = "DeleteInstanceSnapshot"

	// OperationTypeCreateInstancesFromSnapshot is a OperationType enum value
	OperationTypeCreateInstancesFromSnapshot = "CreateInstancesFromSnapshot"

	// OperationTypeCreateLoadBalancer is a OperationType enum value
	OperationTypeCreateLoadBalancer = "CreateLoadBalancer"

	// OperationTypeDeleteLoadBalancer is a OperationType enum value
	OperationTypeDeleteLoadBalancer = "DeleteLoadBalancer"

	// OperationTypeAttachInstancesToLoadBalancer is a OperationType enum value
	OperationTypeAttachInstancesToLoadBalancer = "AttachInstancesToLoadBalancer"

	// OperationTypeDetachInstancesFromLoadBalancer is a OperationType enum value
	OperationTypeDetachInstancesFromLoadBalancer = "DetachInstancesFromLoadBalancer"

	// OperationTypeUpdateLoadBalancerAttribute is a OperationType enum value
	OperationTypeUpdateLoadBalancerAttribute = "UpdateLoadBalancerAttribute"

	// OperationTypeCreateLoadBalancerTlsCertificate is a OperationType enum value
	OperationTypeCreateLoadBalancerTlsCertificate = "CreateLoadBalancerTlsCertificate"

	// OperationTypeDeleteLoadBalancerTlsCertificate is a OperationType enum value
	OperationTypeDeleteLoadBalancerTlsCertificate = "DeleteLoadBalancerTlsCertificate"

	// OperationTypeAttachLoadBalancerTlsCertificate is a OperationType enum value
	OperationTypeAttachLoadBalancerTlsCertificate = "AttachLoadBalancerTlsCertificate"

	// OperationTypeCreateDisk is a OperationType enum value
	OperationTypeCreateDisk = "CreateDisk"

	// OperationTypeDeleteDisk is a OperationType enum value
	OperationTypeDeleteDisk = "DeleteDisk"

	// OperationTypeAttachDisk is a OperationType enum value
	OperationTypeAttachDisk = "AttachDisk"

	// OperationTypeDetachDisk is a OperationType enum value
	OperationTypeDetachDisk = "DetachDisk"

	// OperationTypeCreateDiskSnapshot is a OperationType enum value
	OperationTypeCreateDiskSnapshot = "CreateDiskSnapshot"

	// OperationTypeDeleteDiskSnapshot is a OperationType enum value
	OperationTypeDeleteDiskSnapshot = "DeleteDiskSnapshot"

	// OperationTypeCreateDiskFromSnapshot is a OperationType enum value
	OperationTypeCreateDiskFromSnapshot = "CreateDiskFromSnapshot"

	// OperationTypeCreateRelationalDatabase is a OperationType enum value
	OperationTypeCreateRelationalDatabase = "CreateRelationalDatabase"

	// OperationTypeUpdateRelationalDatabase is a OperationType enum value
	OperationTypeUpdateRelationalDatabase = "UpdateRelationalDatabase"

	// OperationTypeDeleteRelationalDatabase is a OperationType enum value
	OperationTypeDeleteRelationalDatabase = "DeleteRelationalDatabase"

	// OperationTypeCreateRelationalDatabaseFromSnapshot is a OperationType enum value
	OperationTypeCreateRelationalDatabaseFromSnapshot = "CreateRelationalDatabaseFromSnapshot"

	// OperationTypeCreateRelationalDatabaseSnapshot is a OperationType enum value
	OperationTypeCreateRelationalDatabaseSnapshot = "CreateRelationalDatabaseSnapshot"

	// OperationTypeDeleteRelationalDatabaseSnapshot is a OperationType enum value
	OperationTypeDeleteRelationalDatabaseSnapshot = "DeleteRelationalDatabaseSnapshot"

	// OperationTypeUpdateRelationalDatabaseParameters is a OperationType enum value
	OperationTypeUpdateRelationalDatabaseParameters = "UpdateRelationalDatabaseParameters"

	// OperationTypeStartRelationalDatabase is a OperationType enum value
	OperationTypeStartRelationalDatabase = "StartRelationalDatabase"

	// OperationTypeRebootRelationalDatabase is a OperationType enum value
	OperationTypeRebootRelationalDatabase = "RebootRelationalDatabase"

	// OperationTypeStopRelationalDatabase is a OperationType enum value
	OperationTypeStopRelationalDatabase = "StopRelationalDatabase"
)
View Source
const (
	// PortAccessTypePublic is a PortAccessType enum value
	PortAccessTypePublic = "Public"

	// PortAccessTypePrivate is a PortAccessType enum value
	PortAccessTypePrivate = "Private"
)
View Source
const (
	// PortInfoSourceTypeDefault is a PortInfoSourceType enum value
	PortInfoSourceTypeDefault = "DEFAULT"

	// PortInfoSourceTypeInstance is a PortInfoSourceType enum value
	PortInfoSourceTypeInstance = "INSTANCE"

	// PortInfoSourceTypeNone is a PortInfoSourceType enum value
	PortInfoSourceTypeNone = "NONE"

	// PortInfoSourceTypeClosed is a PortInfoSourceType enum value
	PortInfoSourceTypeClosed = "CLOSED"
)
View Source
const (
	// PortStateOpen is a PortState enum value
	PortStateOpen = "open"

	// PortStateClosed is a PortState enum value
	PortStateClosed = "closed"
)
View Source
const (
	// RecordStateStarted is a RecordState enum value
	RecordStateStarted = "Started"

	// RecordStateSucceeded is a RecordState enum value
	RecordStateSucceeded = "Succeeded"

	// RecordStateFailed is a RecordState enum value
	RecordStateFailed = "Failed"
)
View Source
const (
	// RegionNameUsEast1 is a RegionName enum value
	RegionNameUsEast1 = "us-east-1"

	// RegionNameUsEast2 is a RegionName enum value
	RegionNameUsEast2 = "us-east-2"

	// RegionNameUsWest1 is a RegionName enum value
	RegionNameUsWest1 = "us-west-1"

	// RegionNameUsWest2 is a RegionName enum value
	RegionNameUsWest2 = "us-west-2"

	// RegionNameEuWest1 is a RegionName enum value
	RegionNameEuWest1 = "eu-west-1"

	// RegionNameEuWest2 is a RegionName enum value
	RegionNameEuWest2 = "eu-west-2"

	// RegionNameEuWest3 is a RegionName enum value
	RegionNameEuWest3 = "eu-west-3"

	// RegionNameEuCentral1 is a RegionName enum value
	RegionNameEuCentral1 = "eu-central-1"

	// RegionNameCaCentral1 is a RegionName enum value
	RegionNameCaCentral1 = "ca-central-1"

	// RegionNameApSouth1 is a RegionName enum value
	RegionNameApSouth1 = "ap-south-1"

	// RegionNameApSoutheast1 is a RegionName enum value
	RegionNameApSoutheast1 = "ap-southeast-1"

	// RegionNameApSoutheast2 is a RegionName enum value
	RegionNameApSoutheast2 = "ap-southeast-2"

	// RegionNameApNortheast1 is a RegionName enum value
	RegionNameApNortheast1 = "ap-northeast-1"

	// RegionNameApNortheast2 is a RegionName enum value
	RegionNameApNortheast2 = "ap-northeast-2"
)
View Source
const (
	// RelationalDatabaseMetricNameCpuutilization is a RelationalDatabaseMetricName enum value
	RelationalDatabaseMetricNameCpuutilization = "CPUUtilization"

	// RelationalDatabaseMetricNameDatabaseConnections is a RelationalDatabaseMetricName enum value
	RelationalDatabaseMetricNameDatabaseConnections = "DatabaseConnections"

	// RelationalDatabaseMetricNameDiskQueueDepth is a RelationalDatabaseMetricName enum value
	RelationalDatabaseMetricNameDiskQueueDepth = "DiskQueueDepth"

	// RelationalDatabaseMetricNameFreeStorageSpace is a RelationalDatabaseMetricName enum value
	RelationalDatabaseMetricNameFreeStorageSpace = "FreeStorageSpace"

	// RelationalDatabaseMetricNameNetworkReceiveThroughput is a RelationalDatabaseMetricName enum value
	RelationalDatabaseMetricNameNetworkReceiveThroughput = "NetworkReceiveThroughput"

	// RelationalDatabaseMetricNameNetworkTransmitThroughput is a RelationalDatabaseMetricName enum value
	RelationalDatabaseMetricNameNetworkTransmitThroughput = "NetworkTransmitThroughput"
)
View Source
const (
	// RelationalDatabasePasswordVersionCurrent is a RelationalDatabasePasswordVersion enum value
	RelationalDatabasePasswordVersionCurrent = "CURRENT"

	// RelationalDatabasePasswordVersionPrevious is a RelationalDatabasePasswordVersion enum value
	RelationalDatabasePasswordVersionPrevious = "PREVIOUS"

	// RelationalDatabasePasswordVersionPending is a RelationalDatabasePasswordVersion enum value
	RelationalDatabasePasswordVersionPending = "PENDING"
)
View Source
const (
	// ResourceTypeInstance is a ResourceType enum value
	ResourceTypeInstance = "Instance"

	// ResourceTypeStaticIp is a ResourceType enum value
	ResourceTypeStaticIp = "StaticIp"

	// ResourceTypeKeyPair is a ResourceType enum value
	ResourceTypeKeyPair = "KeyPair"

	// ResourceTypeInstanceSnapshot is a ResourceType enum value
	ResourceTypeInstanceSnapshot = "InstanceSnapshot"

	// ResourceTypeDomain is a ResourceType enum value
	ResourceTypeDomain = "Domain"

	// ResourceTypePeeredVpc is a ResourceType enum value
	ResourceTypePeeredVpc = "PeeredVpc"

	// ResourceTypeLoadBalancer is a ResourceType enum value
	ResourceTypeLoadBalancer = "LoadBalancer"

	// ResourceTypeLoadBalancerTlsCertificate is a ResourceType enum value
	ResourceTypeLoadBalancerTlsCertificate = "LoadBalancerTlsCertificate"

	// ResourceTypeDisk is a ResourceType enum value
	ResourceTypeDisk = "Disk"

	// ResourceTypeDiskSnapshot is a ResourceType enum value
	ResourceTypeDiskSnapshot = "DiskSnapshot"

	// ResourceTypeRelationalDatabase is a ResourceType enum value
	ResourceTypeRelationalDatabase = "RelationalDatabase"

	// ResourceTypeRelationalDatabaseSnapshot is a ResourceType enum value
	ResourceTypeRelationalDatabaseSnapshot = "RelationalDatabaseSnapshot"

	// ResourceTypeExportSnapshotRecord is a ResourceType enum value
	ResourceTypeExportSnapshotRecord = "ExportSnapshotRecord"

	// ResourceTypeCloudFormationStackRecord is a ResourceType enum value
	ResourceTypeCloudFormationStackRecord = "CloudFormationStackRecord"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// Lightsail throws this exception when the user cannot be authenticated or
	// uses invalid credentials to access a resource.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeAccountSetupInProgressException for service response error code
	// "AccountSetupInProgressException".
	//
	// Lightsail throws this exception when an account is still in the setup in
	// progress state.
	ErrCodeAccountSetupInProgressException = "AccountSetupInProgressException"

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// Lightsail throws this exception when user input does not conform to the validation
	// rules of an input field.
	//
	// Domain-related APIs are only available in the N. Virginia (us-east-1) Region.
	// Please set your AWS Region configuration to us-east-1 to create, view, or
	// edit these resources.
	ErrCodeInvalidInputException = "InvalidInputException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// Lightsail throws this exception when it cannot find a resource.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeOperationFailureException for service response error code
	// "OperationFailureException".
	//
	// Lightsail throws this exception when an operation fails to execute.
	ErrCodeOperationFailureException = "OperationFailureException"

	// ErrCodeServiceException for service response error code
	// "ServiceException".
	//
	// A general service exception.
	ErrCodeServiceException = "ServiceException"

	// ErrCodeUnauthenticatedException for service response error code
	// "UnauthenticatedException".
	//
	// Lightsail throws this exception when the user has not been authenticated.
	ErrCodeUnauthenticatedException = "UnauthenticatedException"
)
View Source
const (
	ServiceName = "lightsail" // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Lightsail" // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source
const (
	// CloudFormationStackRecordSourceTypeExportSnapshotRecord is a CloudFormationStackRecordSourceType enum value
	CloudFormationStackRecordSourceTypeExportSnapshotRecord = "ExportSnapshotRecord"
)
View Source
const (
	// RelationalDatabaseEngineMysql is a RelationalDatabaseEngine enum value
	RelationalDatabaseEngineMysql = "mysql"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AllocateStaticIpInput

type AllocateStaticIpInput struct {

	// The name of the static IP address.
	//
	// StaticIpName is a required field
	StaticIpName *string `locationName:"staticIpName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AllocateStaticIpInput) GoString

func (s AllocateStaticIpInput) GoString() string

GoString returns the string representation

func (*AllocateStaticIpInput) SetStaticIpName

func (s *AllocateStaticIpInput) SetStaticIpName(v string) *AllocateStaticIpInput

SetStaticIpName sets the StaticIpName field's value.

func (AllocateStaticIpInput) String

func (s AllocateStaticIpInput) String() string

String returns the string representation

func (*AllocateStaticIpInput) Validate

func (s *AllocateStaticIpInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AllocateStaticIpOutput

type AllocateStaticIpOutput struct {

	// An array of key-value pairs containing information about the static IP address
	// you allocated.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AllocateStaticIpOutput) GoString

func (s AllocateStaticIpOutput) GoString() string

GoString returns the string representation

func (*AllocateStaticIpOutput) SetOperations

SetOperations sets the Operations field's value.

func (AllocateStaticIpOutput) String

func (s AllocateStaticIpOutput) String() string

String returns the string representation

type AttachDiskInput added in v1.12.27

type AttachDiskInput struct {

	// The unique Lightsail disk name (e.g., my-disk).
	//
	// DiskName is a required field
	DiskName *string `locationName:"diskName" type:"string" required:"true"`

	// The disk path to expose to the instance (e.g., /dev/xvdf).
	//
	// DiskPath is a required field
	DiskPath *string `locationName:"diskPath" type:"string" required:"true"`

	// The name of the Lightsail instance where you want to utilize the storage
	// disk.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AttachDiskInput) GoString added in v1.12.27

func (s AttachDiskInput) GoString() string

GoString returns the string representation

func (*AttachDiskInput) SetDiskName added in v1.12.27

func (s *AttachDiskInput) SetDiskName(v string) *AttachDiskInput

SetDiskName sets the DiskName field's value.

func (*AttachDiskInput) SetDiskPath added in v1.12.27

func (s *AttachDiskInput) SetDiskPath(v string) *AttachDiskInput

SetDiskPath sets the DiskPath field's value.

func (*AttachDiskInput) SetInstanceName added in v1.12.27

func (s *AttachDiskInput) SetInstanceName(v string) *AttachDiskInput

SetInstanceName sets the InstanceName field's value.

func (AttachDiskInput) String added in v1.12.27

func (s AttachDiskInput) String() string

String returns the string representation

func (*AttachDiskInput) Validate added in v1.12.27

func (s *AttachDiskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttachDiskOutput added in v1.12.27

type AttachDiskOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AttachDiskOutput) GoString added in v1.12.27

func (s AttachDiskOutput) GoString() string

GoString returns the string representation

func (*AttachDiskOutput) SetOperations added in v1.12.27

func (s *AttachDiskOutput) SetOperations(v []*Operation) *AttachDiskOutput

SetOperations sets the Operations field's value.

func (AttachDiskOutput) String added in v1.12.27

func (s AttachDiskOutput) String() string

String returns the string representation

type AttachInstancesToLoadBalancerInput added in v1.12.37

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).
	//
	// InstanceNames is a required field
	InstanceNames []*string `locationName:"instanceNames" type:"list" required:"true"`

	// The name of the load balancer.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AttachInstancesToLoadBalancerInput) GoString added in v1.12.37

GoString returns the string representation

func (*AttachInstancesToLoadBalancerInput) SetInstanceNames added in v1.12.37

SetInstanceNames sets the InstanceNames field's value.

func (*AttachInstancesToLoadBalancerInput) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (AttachInstancesToLoadBalancerInput) String added in v1.12.37

String returns the string representation

func (*AttachInstancesToLoadBalancerInput) Validate added in v1.12.37

Validate inspects the fields of the type to determine if they are valid.

type AttachInstancesToLoadBalancerOutput added in v1.12.37

type AttachInstancesToLoadBalancerOutput struct {

	// An object representing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AttachInstancesToLoadBalancerOutput) GoString added in v1.12.37

GoString returns the string representation

func (*AttachInstancesToLoadBalancerOutput) SetOperations added in v1.12.37

SetOperations sets the Operations field's value.

func (AttachInstancesToLoadBalancerOutput) String added in v1.12.37

String returns the string representation

type AttachLoadBalancerTlsCertificateInput added in v1.12.37

type AttachLoadBalancerTlsCertificateInput struct {

	// The name of your SSL/TLS certificate.
	//
	// CertificateName is a required field
	CertificateName *string `locationName:"certificateName" type:"string" required:"true"`

	// The name of the load balancer to which you want to associate the SSL/TLS
	// certificate.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AttachLoadBalancerTlsCertificateInput) GoString added in v1.12.37

GoString returns the string representation

func (*AttachLoadBalancerTlsCertificateInput) SetCertificateName added in v1.12.37

SetCertificateName sets the CertificateName field's value.

func (*AttachLoadBalancerTlsCertificateInput) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (AttachLoadBalancerTlsCertificateInput) String added in v1.12.37

String returns the string representation

func (*AttachLoadBalancerTlsCertificateInput) Validate added in v1.12.37

Validate inspects the fields of the type to determine if they are valid.

type AttachLoadBalancerTlsCertificateOutput added in v1.12.37

type AttachLoadBalancerTlsCertificateOutput struct {

	// An object representing the API operations.
	//
	// These SSL/TLS certificates are only usable by Lightsail load balancers. You
	// can't get the certificate and use it for another purpose.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AttachLoadBalancerTlsCertificateOutput) GoString added in v1.12.37

GoString returns the string representation

func (*AttachLoadBalancerTlsCertificateOutput) SetOperations added in v1.12.37

SetOperations sets the Operations field's value.

func (AttachLoadBalancerTlsCertificateOutput) String added in v1.12.37

String returns the string representation

type AttachStaticIpInput

type AttachStaticIpInput struct {

	// The instance name to which you want to attach the static IP address.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`

	// The name of the static IP.
	//
	// StaticIpName is a required field
	StaticIpName *string `locationName:"staticIpName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AttachStaticIpInput) GoString

func (s AttachStaticIpInput) GoString() string

GoString returns the string representation

func (*AttachStaticIpInput) SetInstanceName

func (s *AttachStaticIpInput) SetInstanceName(v string) *AttachStaticIpInput

SetInstanceName sets the InstanceName field's value.

func (*AttachStaticIpInput) SetStaticIpName

func (s *AttachStaticIpInput) SetStaticIpName(v string) *AttachStaticIpInput

SetStaticIpName sets the StaticIpName field's value.

func (AttachStaticIpInput) String

func (s AttachStaticIpInput) String() string

String returns the string representation

func (*AttachStaticIpInput) Validate

func (s *AttachStaticIpInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttachStaticIpOutput

type AttachStaticIpOutput struct {

	// An array of key-value pairs containing information about your API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AttachStaticIpOutput) GoString

func (s AttachStaticIpOutput) GoString() string

GoString returns the string representation

func (*AttachStaticIpOutput) SetOperations

func (s *AttachStaticIpOutput) SetOperations(v []*Operation) *AttachStaticIpOutput

SetOperations sets the Operations field's value.

func (AttachStaticIpOutput) String

func (s AttachStaticIpOutput) String() string

String returns the string representation

type AvailabilityZone

type AvailabilityZone struct {

	// The state of the Availability Zone.
	State *string `locationName:"state" type:"string"`

	// The name of the Availability Zone. The format is us-east-2a (case-sensitive).
	ZoneName *string `locationName:"zoneName" type:"string"`
	// contains filtered or unexported fields
}

Describes an Availability Zone.

func (AvailabilityZone) GoString

func (s AvailabilityZone) GoString() string

GoString returns the string representation

func (*AvailabilityZone) SetState

func (s *AvailabilityZone) SetState(v string) *AvailabilityZone

SetState sets the State field's value.

func (*AvailabilityZone) SetZoneName

func (s *AvailabilityZone) SetZoneName(v string) *AvailabilityZone

SetZoneName sets the ZoneName field's value.

func (AvailabilityZone) String

func (s AvailabilityZone) String() string

String returns the string representation

type Blueprint

type Blueprint struct {

	// The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
	BlueprintId *string `locationName:"blueprintId" type:"string"`

	// The description of the blueprint.
	Description *string `locationName:"description" type:"string"`

	// The group name of the blueprint (e.g., amazon-linux).
	Group *string `locationName:"group" type:"string"`

	// A Boolean value indicating whether the blueprint is active. Inactive blueprints
	// are listed to support customers with existing instances but are not necessarily
	// available for launch of new instances. Blueprints are marked inactive when
	// they become outdated due to operating system updates or new application releases.
	IsActive *bool `locationName:"isActive" type:"boolean"`

	// The end-user license agreement URL for the image or blueprint.
	LicenseUrl *string `locationName:"licenseUrl" type:"string"`

	// The minimum bundle power required to run this blueprint. For example, you
	// need a bundle with a power value of 500 or more to create an instance that
	// uses a blueprint with a minimum power value of 500. 0 indicates that the
	// blueprint runs on all instance sizes.
	MinPower *int64 `locationName:"minPower" type:"integer"`

	// The friendly name of the blueprint (e.g., Amazon Linux).
	Name *string `locationName:"name" type:"string"`

	// The operating system platform (either Linux/Unix-based or Windows Server-based)
	// of the blueprint.
	Platform *string `locationName:"platform" type:"string" enum:"InstancePlatform"`

	// The product URL to learn more about the image or blueprint.
	ProductUrl *string `locationName:"productUrl" type:"string"`

	// The type of the blueprint (e.g., os or app).
	Type *string `locationName:"type" type:"string" enum:"BlueprintType"`

	// The version number of the operating system, application, or stack (e.g.,
	// 2016.03.0).
	Version *string `locationName:"version" type:"string"`

	// The version code.
	VersionCode *string `locationName:"versionCode" type:"string"`
	// contains filtered or unexported fields
}

Describes a blueprint (a virtual private server image).

func (Blueprint) GoString

func (s Blueprint) GoString() string

GoString returns the string representation

func (*Blueprint) SetBlueprintId

func (s *Blueprint) SetBlueprintId(v string) *Blueprint

SetBlueprintId sets the BlueprintId field's value.

func (*Blueprint) SetDescription

func (s *Blueprint) SetDescription(v string) *Blueprint

SetDescription sets the Description field's value.

func (*Blueprint) SetGroup

func (s *Blueprint) SetGroup(v string) *Blueprint

SetGroup sets the Group field's value.

func (*Blueprint) SetIsActive

func (s *Blueprint) SetIsActive(v bool) *Blueprint

SetIsActive sets the IsActive field's value.

func (*Blueprint) SetLicenseUrl

func (s *Blueprint) SetLicenseUrl(v string) *Blueprint

SetLicenseUrl sets the LicenseUrl field's value.

func (*Blueprint) SetMinPower

func (s *Blueprint) SetMinPower(v int64) *Blueprint

SetMinPower sets the MinPower field's value.

func (*Blueprint) SetName

func (s *Blueprint) SetName(v string) *Blueprint

SetName sets the Name field's value.

func (*Blueprint) SetPlatform added in v1.12.13

func (s *Blueprint) SetPlatform(v string) *Blueprint

SetPlatform sets the Platform field's value.

func (*Blueprint) SetProductUrl

func (s *Blueprint) SetProductUrl(v string) *Blueprint

SetProductUrl sets the ProductUrl field's value.

func (*Blueprint) SetType

func (s *Blueprint) SetType(v string) *Blueprint

SetType sets the Type field's value.

func (*Blueprint) SetVersion

func (s *Blueprint) SetVersion(v string) *Blueprint

SetVersion sets the Version field's value.

func (*Blueprint) SetVersionCode

func (s *Blueprint) SetVersionCode(v string) *Blueprint

SetVersionCode sets the VersionCode field's value.

func (Blueprint) String

func (s Blueprint) String() string

String returns the string representation

type Bundle

type Bundle struct {

	// The bundle ID (e.g., micro_1_0).
	BundleId *string `locationName:"bundleId" type:"string"`

	// The number of vCPUs included in the bundle (e.g., 2).
	CpuCount *int64 `locationName:"cpuCount" type:"integer"`

	// The size of the SSD (e.g., 30).
	DiskSizeInGb *int64 `locationName:"diskSizeInGb" type:"integer"`

	// The Amazon EC2 instance type (e.g., t2.micro).
	InstanceType *string `locationName:"instanceType" type:"string"`

	// A Boolean value indicating whether the bundle is active.
	IsActive *bool `locationName:"isActive" type:"boolean"`

	// A friendly name for the bundle (e.g., Micro).
	Name *string `locationName:"name" type:"string"`

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

	// The price in US dollars (e.g., 5.0).
	Price *float64 `locationName:"price" type:"float"`

	// The amount of RAM in GB (e.g., 2.0).
	RamSizeInGb *float64 `locationName:"ramSizeInGb" type:"float"`

	// The operating system platform (Linux/Unix-based or Windows Server-based)
	// that the bundle supports. You can only launch a WINDOWS bundle on a blueprint
	// that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX
	// bundle.
	SupportedPlatforms []*string `locationName:"supportedPlatforms" type:"list"`

	// The data transfer rate per month in GB (e.g., 2000).
	TransferPerMonthInGb *int64 `locationName:"transferPerMonthInGb" type:"integer"`
	// contains filtered or unexported fields
}

Describes a bundle, which is a set of specs describing your virtual private server (or instance).

func (Bundle) GoString

func (s Bundle) GoString() string

GoString returns the string representation

func (*Bundle) SetBundleId

func (s *Bundle) SetBundleId(v string) *Bundle

SetBundleId sets the BundleId field's value.

func (*Bundle) SetCpuCount

func (s *Bundle) SetCpuCount(v int64) *Bundle

SetCpuCount sets the CpuCount field's value.

func (*Bundle) SetDiskSizeInGb

func (s *Bundle) SetDiskSizeInGb(v int64) *Bundle

SetDiskSizeInGb sets the DiskSizeInGb field's value.

func (*Bundle) SetInstanceType

func (s *Bundle) SetInstanceType(v string) *Bundle

SetInstanceType sets the InstanceType field's value.

func (*Bundle) SetIsActive

func (s *Bundle) SetIsActive(v bool) *Bundle

SetIsActive sets the IsActive field's value.

func (*Bundle) SetName

func (s *Bundle) SetName(v string) *Bundle

SetName sets the Name field's value.

func (*Bundle) SetPower

func (s *Bundle) SetPower(v int64) *Bundle

SetPower sets the Power field's value.

func (*Bundle) SetPrice

func (s *Bundle) SetPrice(v float64) *Bundle

SetPrice sets the Price field's value.

func (*Bundle) SetRamSizeInGb

func (s *Bundle) SetRamSizeInGb(v float64) *Bundle

SetRamSizeInGb sets the RamSizeInGb field's value.

func (*Bundle) SetSupportedPlatforms added in v1.12.13

func (s *Bundle) SetSupportedPlatforms(v []*string) *Bundle

SetSupportedPlatforms sets the SupportedPlatforms field's value.

func (*Bundle) SetTransferPerMonthInGb

func (s *Bundle) SetTransferPerMonthInGb(v int64) *Bundle

SetTransferPerMonthInGb sets the TransferPerMonthInGb field's value.

func (Bundle) String

func (s Bundle) String() string

String returns the string representation

type CloseInstancePublicPortsInput

type CloseInstancePublicPortsInput struct {

	// The name of the instance on which you're attempting to close the public ports.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`

	// Information about the public port you are trying to close.
	//
	// PortInfo is a required field
	PortInfo *PortInfo `locationName:"portInfo" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CloseInstancePublicPortsInput) GoString

GoString returns the string representation

func (*CloseInstancePublicPortsInput) SetInstanceName

SetInstanceName sets the InstanceName field's value.

func (*CloseInstancePublicPortsInput) SetPortInfo

SetPortInfo sets the PortInfo field's value.

func (CloseInstancePublicPortsInput) String

String returns the string representation

func (*CloseInstancePublicPortsInput) Validate

func (s *CloseInstancePublicPortsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CloseInstancePublicPortsOutput

type CloseInstancePublicPortsOutput struct {

	// An array of key-value pairs that contains information about the operation.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (CloseInstancePublicPortsOutput) GoString

GoString returns the string representation

func (*CloseInstancePublicPortsOutput) SetOperation

SetOperation sets the Operation field's value.

func (CloseInstancePublicPortsOutput) String

String returns the string representation

type CloudFormationStackRecord added in v1.99.0

type CloudFormationStackRecord struct {

	// The Amazon Resource Name (ARN) of the CloudFormation stack record.
	Arn *string `locationName:"arn" type:"string"`

	// The date when the CloudFormation stack record was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A list of objects describing the destination service, which is AWS CloudFormation,
	// and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
	DestinationInfo *DestinationInfo `locationName:"destinationInfo" type:"structure"`

	// A list of objects describing the Availability Zone and AWS Region of the
	// CloudFormation stack record.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the CloudFormation stack record. It starts with CloudFormationStackRecord
	// followed by a GUID.
	Name *string `locationName:"name" type:"string"`

	// The Lightsail resource type (e.g., CloudFormationStackRecord).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// A list of objects describing the source of the CloudFormation stack record.
	SourceInfo []*CloudFormationStackRecordSourceInfo `locationName:"sourceInfo" type:"list"`

	// The current state of the CloudFormation stack record.
	State *string `locationName:"state" type:"string" enum:"RecordState"`
	// contains filtered or unexported fields
}

Describes a CloudFormation stack record created as a result of the create cloud formation stack operation.

A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

func (CloudFormationStackRecord) GoString added in v1.99.0

func (s CloudFormationStackRecord) GoString() string

GoString returns the string representation

func (*CloudFormationStackRecord) SetArn added in v1.99.0

SetArn sets the Arn field's value.

func (*CloudFormationStackRecord) SetCreatedAt added in v1.99.0

SetCreatedAt sets the CreatedAt field's value.

func (*CloudFormationStackRecord) SetDestinationInfo added in v1.99.0

SetDestinationInfo sets the DestinationInfo field's value.

func (*CloudFormationStackRecord) SetLocation added in v1.99.0

SetLocation sets the Location field's value.

func (*CloudFormationStackRecord) SetName added in v1.99.0

SetName sets the Name field's value.

func (*CloudFormationStackRecord) SetResourceType added in v1.99.0

SetResourceType sets the ResourceType field's value.

func (*CloudFormationStackRecord) SetSourceInfo added in v1.99.0

SetSourceInfo sets the SourceInfo field's value.

func (*CloudFormationStackRecord) SetState added in v1.99.0

SetState sets the State field's value.

func (CloudFormationStackRecord) String added in v1.99.0

func (s CloudFormationStackRecord) String() string

String returns the string representation

type CloudFormationStackRecordSourceInfo added in v1.99.0

type CloudFormationStackRecordSourceInfo struct {

	// The Amazon Resource Name (ARN) of the export snapshot record.
	Arn *string `locationName:"arn" type:"string"`

	// The name of the record.
	Name *string `locationName:"name" type:"string"`

	// The Lightsail resource type (e.g., ExportSnapshotRecord).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"CloudFormationStackRecordSourceType"`
	// contains filtered or unexported fields
}

Describes the source of a CloudFormation stack record (i.e., the export snapshot record).

func (CloudFormationStackRecordSourceInfo) GoString added in v1.99.0

GoString returns the string representation

func (*CloudFormationStackRecordSourceInfo) SetArn added in v1.99.0

SetArn sets the Arn field's value.

func (*CloudFormationStackRecordSourceInfo) SetName added in v1.99.0

SetName sets the Name field's value.

func (*CloudFormationStackRecordSourceInfo) SetResourceType added in v1.99.0

SetResourceType sets the ResourceType field's value.

func (CloudFormationStackRecordSourceInfo) String added in v1.99.0

String returns the string representation

type CopySnapshotInput added in v1.99.0

type CopySnapshotInput struct {

	// The AWS Region where the source snapshot is located.
	//
	// SourceRegion is a required field
	SourceRegion *string `locationName:"sourceRegion" type:"string" required:"true" enum:"RegionName"`

	// The name of the source instance or disk snapshot to be copied.
	//
	// SourceSnapshotName is a required field
	SourceSnapshotName *string `locationName:"sourceSnapshotName" type:"string" required:"true"`

	// The name of the new instance or disk snapshot to be created as a copy.
	//
	// TargetSnapshotName is a required field
	TargetSnapshotName *string `locationName:"targetSnapshotName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopySnapshotInput) GoString added in v1.99.0

func (s CopySnapshotInput) GoString() string

GoString returns the string representation

func (*CopySnapshotInput) SetSourceRegion added in v1.99.0

func (s *CopySnapshotInput) SetSourceRegion(v string) *CopySnapshotInput

SetSourceRegion sets the SourceRegion field's value.

func (*CopySnapshotInput) SetSourceSnapshotName added in v1.99.0

func (s *CopySnapshotInput) SetSourceSnapshotName(v string) *CopySnapshotInput

SetSourceSnapshotName sets the SourceSnapshotName field's value.

func (*CopySnapshotInput) SetTargetSnapshotName added in v1.99.0

func (s *CopySnapshotInput) SetTargetSnapshotName(v string) *CopySnapshotInput

SetTargetSnapshotName sets the TargetSnapshotName field's value.

func (CopySnapshotInput) String added in v1.99.0

func (s CopySnapshotInput) String() string

String returns the string representation

func (*CopySnapshotInput) Validate added in v1.99.0

func (s *CopySnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopySnapshotOutput added in v1.99.0

type CopySnapshotOutput struct {

	// A list of objects describing the API operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CopySnapshotOutput) GoString added in v1.99.0

func (s CopySnapshotOutput) GoString() string

GoString returns the string representation

func (*CopySnapshotOutput) SetOperations added in v1.99.0

func (s *CopySnapshotOutput) SetOperations(v []*Operation) *CopySnapshotOutput

SetOperations sets the Operations field's value.

func (CopySnapshotOutput) String added in v1.99.0

func (s CopySnapshotOutput) String() string

String returns the string representation

type CreateCloudFormationStackInput added in v1.99.0

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.
	//
	// Instances is a required field
	Instances []*InstanceEntry `locationName:"instances" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCloudFormationStackInput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateCloudFormationStackInput) SetInstances added in v1.99.0

SetInstances sets the Instances field's value.

func (CreateCloudFormationStackInput) String added in v1.99.0

String returns the string representation

func (*CreateCloudFormationStackInput) Validate added in v1.99.0

func (s *CreateCloudFormationStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCloudFormationStackOutput added in v1.99.0

type CreateCloudFormationStackOutput struct {

	// A list of objects describing the API operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateCloudFormationStackOutput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateCloudFormationStackOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (CreateCloudFormationStackOutput) String added in v1.99.0

String returns the string representation

type CreateDiskFromSnapshotInput added in v1.12.27

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.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `locationName:"availabilityZone" type:"string" required:"true"`

	// The unique Lightsail disk name (e.g., my-disk).
	//
	// DiskName is a required field
	DiskName *string `locationName:"diskName" type:"string" required:"true"`

	// The name of the disk snapshot (e.g., my-snapshot) from which to create the
	// new storage disk.
	//
	// DiskSnapshotName is a required field
	DiskSnapshotName *string `locationName:"diskSnapshotName" type:"string" required:"true"`

	// The size of the disk in GB (e.g., 32).
	//
	// SizeInGb is a required field
	SizeInGb *int64 `locationName:"sizeInGb" type:"integer" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDiskFromSnapshotInput) GoString added in v1.12.27

func (s CreateDiskFromSnapshotInput) GoString() string

GoString returns the string representation

func (*CreateDiskFromSnapshotInput) SetAvailabilityZone added in v1.12.27

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateDiskFromSnapshotInput) SetDiskName added in v1.12.27

SetDiskName sets the DiskName field's value.

func (*CreateDiskFromSnapshotInput) SetDiskSnapshotName added in v1.12.27

SetDiskSnapshotName sets the DiskSnapshotName field's value.

func (*CreateDiskFromSnapshotInput) SetSizeInGb added in v1.12.27

SetSizeInGb sets the SizeInGb field's value.

func (*CreateDiskFromSnapshotInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateDiskFromSnapshotInput) String added in v1.12.27

String returns the string representation

func (*CreateDiskFromSnapshotInput) Validate added in v1.12.27

func (s *CreateDiskFromSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDiskFromSnapshotOutput added in v1.12.27

type CreateDiskFromSnapshotOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDiskFromSnapshotOutput) GoString added in v1.12.27

func (s CreateDiskFromSnapshotOutput) GoString() string

GoString returns the string representation

func (*CreateDiskFromSnapshotOutput) SetOperations added in v1.12.27

SetOperations sets the Operations field's value.

func (CreateDiskFromSnapshotOutput) String added in v1.12.27

String returns the string representation

type CreateDiskInput added in v1.12.27

type CreateDiskInput 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.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `locationName:"availabilityZone" type:"string" required:"true"`

	// The unique Lightsail disk name (e.g., my-disk).
	//
	// DiskName is a required field
	DiskName *string `locationName:"diskName" type:"string" required:"true"`

	// The size of the disk in GB (e.g., 32).
	//
	// SizeInGb is a required field
	SizeInGb *int64 `locationName:"sizeInGb" type:"integer" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDiskInput) GoString added in v1.12.27

func (s CreateDiskInput) GoString() string

GoString returns the string representation

func (*CreateDiskInput) SetAvailabilityZone added in v1.12.27

func (s *CreateDiskInput) SetAvailabilityZone(v string) *CreateDiskInput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateDiskInput) SetDiskName added in v1.12.27

func (s *CreateDiskInput) SetDiskName(v string) *CreateDiskInput

SetDiskName sets the DiskName field's value.

func (*CreateDiskInput) SetSizeInGb added in v1.12.27

func (s *CreateDiskInput) SetSizeInGb(v int64) *CreateDiskInput

SetSizeInGb sets the SizeInGb field's value.

func (*CreateDiskInput) SetTags added in v1.99.0

func (s *CreateDiskInput) SetTags(v []*Tag) *CreateDiskInput

SetTags sets the Tags field's value.

func (CreateDiskInput) String added in v1.12.27

func (s CreateDiskInput) String() string

String returns the string representation

func (*CreateDiskInput) Validate added in v1.12.27

func (s *CreateDiskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDiskOutput added in v1.12.27

type CreateDiskOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDiskOutput) GoString added in v1.12.27

func (s CreateDiskOutput) GoString() string

GoString returns the string representation

func (*CreateDiskOutput) SetOperations added in v1.12.27

func (s *CreateDiskOutput) SetOperations(v []*Operation) *CreateDiskOutput

SetOperations sets the Operations field's value.

func (CreateDiskOutput) String added in v1.12.27

func (s CreateDiskOutput) String() string

String returns the string representation

type CreateDiskSnapshotInput added in v1.12.27

type CreateDiskSnapshotInput struct {

	// 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 `locationName:"diskName" type:"string"`

	// The name of the destination disk snapshot (e.g., my-disk-snapshot) based
	// on the source disk.
	//
	// DiskSnapshotName is a required field
	DiskSnapshotName *string `locationName:"diskSnapshotName" type:"string" required:"true"`

	// 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 `locationName:"instanceName" type:"string"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDiskSnapshotInput) GoString added in v1.12.27

func (s CreateDiskSnapshotInput) GoString() string

GoString returns the string representation

func (*CreateDiskSnapshotInput) SetDiskName added in v1.12.27

SetDiskName sets the DiskName field's value.

func (*CreateDiskSnapshotInput) SetDiskSnapshotName added in v1.12.27

func (s *CreateDiskSnapshotInput) SetDiskSnapshotName(v string) *CreateDiskSnapshotInput

SetDiskSnapshotName sets the DiskSnapshotName field's value.

func (*CreateDiskSnapshotInput) SetInstanceName added in v1.99.0

SetInstanceName sets the InstanceName field's value.

func (*CreateDiskSnapshotInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateDiskSnapshotInput) String added in v1.12.27

func (s CreateDiskSnapshotInput) String() string

String returns the string representation

func (*CreateDiskSnapshotInput) Validate added in v1.12.27

func (s *CreateDiskSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDiskSnapshotOutput added in v1.12.27

type CreateDiskSnapshotOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDiskSnapshotOutput) GoString added in v1.12.27

func (s CreateDiskSnapshotOutput) GoString() string

GoString returns the string representation

func (*CreateDiskSnapshotOutput) SetOperations added in v1.12.27

SetOperations sets the Operations field's value.

func (CreateDiskSnapshotOutput) String added in v1.12.27

func (s CreateDiskSnapshotOutput) String() string

String returns the string representation

type CreateDomainEntryInput

type CreateDomainEntryInput struct {

	// An array of key-value pairs containing information about the domain entry
	// request.
	//
	// DomainEntry is a required field
	DomainEntry *DomainEntry `locationName:"domainEntry" type:"structure" required:"true"`

	// The domain name (e.g., example.com) for which you want to create the domain
	// entry.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDomainEntryInput) GoString

func (s CreateDomainEntryInput) GoString() string

GoString returns the string representation

func (*CreateDomainEntryInput) SetDomainEntry

SetDomainEntry sets the DomainEntry field's value.

func (*CreateDomainEntryInput) SetDomainName

SetDomainName sets the DomainName field's value.

func (CreateDomainEntryInput) String

func (s CreateDomainEntryInput) String() string

String returns the string representation

func (*CreateDomainEntryInput) Validate

func (s *CreateDomainEntryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDomainEntryOutput

type CreateDomainEntryOutput struct {

	// An array of key-value pairs containing information about the operation.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDomainEntryOutput) GoString

func (s CreateDomainEntryOutput) GoString() string

GoString returns the string representation

func (*CreateDomainEntryOutput) SetOperation

SetOperation sets the Operation field's value.

func (CreateDomainEntryOutput) String

func (s CreateDomainEntryOutput) String() string

String returns the string representation

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.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDomainInput) GoString

func (s CreateDomainInput) GoString() string

GoString returns the string representation

func (*CreateDomainInput) SetDomainName

func (s *CreateDomainInput) SetDomainName(v string) *CreateDomainInput

SetDomainName sets the DomainName field's value.

func (*CreateDomainInput) SetTags added in v1.99.0

func (s *CreateDomainInput) SetTags(v []*Tag) *CreateDomainInput

SetTags sets the Tags field's value.

func (CreateDomainInput) String

func (s CreateDomainInput) String() string

String returns the string representation

func (*CreateDomainInput) Validate

func (s *CreateDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDomainOutput

type CreateDomainOutput struct {

	// An array of key-value pairs containing information about the domain resource
	// you created.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDomainOutput) GoString

func (s CreateDomainOutput) GoString() string

GoString returns the string representation

func (*CreateDomainOutput) SetOperation

func (s *CreateDomainOutput) SetOperation(v *Operation) *CreateDomainOutput

SetOperation sets the Operation field's value.

func (CreateDomainOutput) String

func (s CreateDomainOutput) String() string

String returns the string representation

type CreateInstanceSnapshotInput

type CreateInstanceSnapshotInput struct {

	// The Lightsail instance on which to base your snapshot.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`

	// The name for your new snapshot.
	//
	// InstanceSnapshotName is a required field
	InstanceSnapshotName *string `locationName:"instanceSnapshotName" type:"string" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInstanceSnapshotInput) GoString

func (s CreateInstanceSnapshotInput) GoString() string

GoString returns the string representation

func (*CreateInstanceSnapshotInput) SetInstanceName

SetInstanceName sets the InstanceName field's value.

func (*CreateInstanceSnapshotInput) SetInstanceSnapshotName

func (s *CreateInstanceSnapshotInput) SetInstanceSnapshotName(v string) *CreateInstanceSnapshotInput

SetInstanceSnapshotName sets the InstanceSnapshotName field's value.

func (*CreateInstanceSnapshotInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateInstanceSnapshotInput) String

String returns the string representation

func (*CreateInstanceSnapshotInput) Validate

func (s *CreateInstanceSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateInstanceSnapshotOutput

type CreateInstanceSnapshotOutput struct {

	// An array of key-value pairs containing information about the results of your
	// create instances snapshot request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInstanceSnapshotOutput) GoString

func (s CreateInstanceSnapshotOutput) GoString() string

GoString returns the string representation

func (*CreateInstanceSnapshotOutput) SetOperations

SetOperations sets the Operations field's value.

func (CreateInstanceSnapshotOutput) String

String returns the string representation

type CreateInstancesFromSnapshotInput

type CreateInstancesFromSnapshotInput struct {

	// An object containing information about one or more disk mappings.
	AttachedDiskMapping map[string][]*DiskMap `locationName:"attachedDiskMapping" type:"map"`

	// 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.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `locationName:"availabilityZone" type:"string" required:"true"`

	// The bundle of specification information for your virtual private server (or
	// instance), including the pricing plan (e.g., micro_1_0).
	//
	// BundleId is a required field
	BundleId *string `locationName:"bundleId" type:"string" required:"true"`

	// The names for your new instances.
	//
	// InstanceNames is a required field
	InstanceNames []*string `locationName:"instanceNames" type:"list" required:"true"`

	// 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.
	//
	// InstanceSnapshotName is a required field
	InstanceSnapshotName *string `locationName:"instanceSnapshotName" type:"string" required:"true"`

	// The name for your key pair.
	KeyPairName *string `locationName:"keyPairName" type:"string"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`

	// 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 `locationName:"userData" type:"string"`
	// contains filtered or unexported fields
}

func (CreateInstancesFromSnapshotInput) GoString

GoString returns the string representation

func (*CreateInstancesFromSnapshotInput) SetAttachedDiskMapping added in v1.12.27

SetAttachedDiskMapping sets the AttachedDiskMapping field's value.

func (*CreateInstancesFromSnapshotInput) SetAvailabilityZone

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateInstancesFromSnapshotInput) SetBundleId

SetBundleId sets the BundleId field's value.

func (*CreateInstancesFromSnapshotInput) SetInstanceNames

SetInstanceNames sets the InstanceNames field's value.

func (*CreateInstancesFromSnapshotInput) SetInstanceSnapshotName

SetInstanceSnapshotName sets the InstanceSnapshotName field's value.

func (*CreateInstancesFromSnapshotInput) SetKeyPairName

SetKeyPairName sets the KeyPairName field's value.

func (*CreateInstancesFromSnapshotInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (*CreateInstancesFromSnapshotInput) SetUserData

SetUserData sets the UserData field's value.

func (CreateInstancesFromSnapshotInput) String

String returns the string representation

func (*CreateInstancesFromSnapshotInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type CreateInstancesFromSnapshotOutput

type CreateInstancesFromSnapshotOutput struct {

	// An array of key-value pairs containing information about the results of your
	// create instances from snapshot request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInstancesFromSnapshotOutput) GoString

GoString returns the string representation

func (*CreateInstancesFromSnapshotOutput) SetOperations

SetOperations sets the Operations field's value.

func (CreateInstancesFromSnapshotOutput) String

String returns the string representation

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.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `locationName:"availabilityZone" type:"string" required:"true"`

	// 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).
	//
	// BlueprintId is a required field
	BlueprintId *string `locationName:"blueprintId" type:"string" required:"true"`

	// The bundle of specification information for your virtual private server (or
	// instance), including the pricing plan (e.g., micro_1_0).
	//
	// BundleId is a required field
	BundleId *string `locationName:"bundleId" type:"string" required:"true"`

	// (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: CustomImageName has been deprecated
	CustomImageName *string `locationName:"customImageName" deprecated:"true" type:"string"`

	// The names to use for your new Lightsail instances. Separate multiple values
	// using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
	//
	// InstanceNames is a required field
	InstanceNames []*string `locationName:"instanceNames" type:"list" required:"true"`

	// The name of your key pair.
	KeyPairName *string `locationName:"keyPairName" type:"string"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`

	// 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 `locationName:"userData" type:"string"`
	// contains filtered or unexported fields
}

func (CreateInstancesInput) GoString

func (s CreateInstancesInput) GoString() string

GoString returns the string representation

func (*CreateInstancesInput) SetAvailabilityZone

func (s *CreateInstancesInput) SetAvailabilityZone(v string) *CreateInstancesInput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateInstancesInput) SetBlueprintId

func (s *CreateInstancesInput) SetBlueprintId(v string) *CreateInstancesInput

SetBlueprintId sets the BlueprintId field's value.

func (*CreateInstancesInput) SetBundleId

SetBundleId sets the BundleId field's value.

func (*CreateInstancesInput) SetCustomImageName

func (s *CreateInstancesInput) SetCustomImageName(v string) *CreateInstancesInput

SetCustomImageName sets the CustomImageName field's value.

func (*CreateInstancesInput) SetInstanceNames

func (s *CreateInstancesInput) SetInstanceNames(v []*string) *CreateInstancesInput

SetInstanceNames sets the InstanceNames field's value.

func (*CreateInstancesInput) SetKeyPairName

func (s *CreateInstancesInput) SetKeyPairName(v string) *CreateInstancesInput

SetKeyPairName sets the KeyPairName field's value.

func (*CreateInstancesInput) SetTags added in v1.99.0

func (s *CreateInstancesInput) SetTags(v []*Tag) *CreateInstancesInput

SetTags sets the Tags field's value.

func (*CreateInstancesInput) SetUserData

SetUserData sets the UserData field's value.

func (CreateInstancesInput) String

func (s CreateInstancesInput) String() string

String returns the string representation

func (*CreateInstancesInput) Validate

func (s *CreateInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateInstancesOutput

type CreateInstancesOutput struct {

	// An array of key-value pairs containing information about the results of your
	// create instances request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInstancesOutput) GoString

func (s CreateInstancesOutput) GoString() string

GoString returns the string representation

func (*CreateInstancesOutput) SetOperations

func (s *CreateInstancesOutput) SetOperations(v []*Operation) *CreateInstancesOutput

SetOperations sets the Operations field's value.

func (CreateInstancesOutput) String

func (s CreateInstancesOutput) String() string

String returns the string representation

type CreateKeyPairInput

type CreateKeyPairInput struct {

	// The name for your new key pair.
	//
	// KeyPairName is a required field
	KeyPairName *string `locationName:"keyPairName" type:"string" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateKeyPairInput) GoString

func (s CreateKeyPairInput) GoString() string

GoString returns the string representation

func (*CreateKeyPairInput) SetKeyPairName

func (s *CreateKeyPairInput) SetKeyPairName(v string) *CreateKeyPairInput

SetKeyPairName sets the KeyPairName field's value.

func (*CreateKeyPairInput) SetTags added in v1.99.0

func (s *CreateKeyPairInput) SetTags(v []*Tag) *CreateKeyPairInput

SetTags sets the Tags field's value.

func (CreateKeyPairInput) String

func (s CreateKeyPairInput) String() string

String returns the string representation

func (*CreateKeyPairInput) Validate

func (s *CreateKeyPairInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKeyPairOutput

type CreateKeyPairOutput struct {

	// An array of key-value pairs containing information about the new key pair
	// you just created.
	KeyPair *KeyPair `locationName:"keyPair" type:"structure"`

	// An array of key-value pairs containing information about the results of your
	// create key pair request.
	Operation *Operation `locationName:"operation" type:"structure"`

	// A base64-encoded RSA private key.
	PrivateKeyBase64 *string `locationName:"privateKeyBase64" type:"string"`

	// A base64-encoded public key of the ssh-rsa type.
	PublicKeyBase64 *string `locationName:"publicKeyBase64" type:"string"`
	// contains filtered or unexported fields
}

func (CreateKeyPairOutput) GoString

func (s CreateKeyPairOutput) GoString() string

GoString returns the string representation

func (*CreateKeyPairOutput) SetKeyPair

func (s *CreateKeyPairOutput) SetKeyPair(v *KeyPair) *CreateKeyPairOutput

SetKeyPair sets the KeyPair field's value.

func (*CreateKeyPairOutput) SetOperation

func (s *CreateKeyPairOutput) SetOperation(v *Operation) *CreateKeyPairOutput

SetOperation sets the Operation field's value.

func (*CreateKeyPairOutput) SetPrivateKeyBase64

func (s *CreateKeyPairOutput) SetPrivateKeyBase64(v string) *CreateKeyPairOutput

SetPrivateKeyBase64 sets the PrivateKeyBase64 field's value.

func (*CreateKeyPairOutput) SetPublicKeyBase64

func (s *CreateKeyPairOutput) SetPublicKeyBase64(v string) *CreateKeyPairOutput

SetPublicKeyBase64 sets the PublicKeyBase64 field's value.

func (CreateKeyPairOutput) String

func (s CreateKeyPairOutput) String() string

String returns the string representation

type CreateLoadBalancerInput added in v1.12.37

type CreateLoadBalancerInput struct {

	// 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 `locationName:"certificateAlternativeNames" type:"list"`

	// 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 `locationName:"certificateDomainName" type:"string"`

	// The name of the SSL/TLS certificate.
	//
	// If you specify certificateName, then certificateDomainName is required (and
	// vice-versa).
	CertificateName *string `locationName:"certificateName" type:"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 `locationName:"healthCheckPath" type:"string"`

	// The instance port where you're creating your load balancer.
	//
	// InstancePort is a required field
	InstancePort *int64 `locationName:"instancePort" type:"integer" required:"true"`

	// The name of your load balancer.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerInput) GoString added in v1.12.37

func (s CreateLoadBalancerInput) GoString() string

GoString returns the string representation

func (*CreateLoadBalancerInput) SetCertificateAlternativeNames added in v1.12.37

func (s *CreateLoadBalancerInput) SetCertificateAlternativeNames(v []*string) *CreateLoadBalancerInput

SetCertificateAlternativeNames sets the CertificateAlternativeNames field's value.

func (*CreateLoadBalancerInput) SetCertificateDomainName added in v1.12.37

func (s *CreateLoadBalancerInput) SetCertificateDomainName(v string) *CreateLoadBalancerInput

SetCertificateDomainName sets the CertificateDomainName field's value.

func (*CreateLoadBalancerInput) SetCertificateName added in v1.12.37

func (s *CreateLoadBalancerInput) SetCertificateName(v string) *CreateLoadBalancerInput

SetCertificateName sets the CertificateName field's value.

func (*CreateLoadBalancerInput) SetHealthCheckPath added in v1.12.37

func (s *CreateLoadBalancerInput) SetHealthCheckPath(v string) *CreateLoadBalancerInput

SetHealthCheckPath sets the HealthCheckPath field's value.

func (*CreateLoadBalancerInput) SetInstancePort added in v1.12.37

func (s *CreateLoadBalancerInput) SetInstancePort(v int64) *CreateLoadBalancerInput

SetInstancePort sets the InstancePort field's value.

func (*CreateLoadBalancerInput) SetLoadBalancerName added in v1.12.37

func (s *CreateLoadBalancerInput) SetLoadBalancerName(v string) *CreateLoadBalancerInput

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*CreateLoadBalancerInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateLoadBalancerInput) String added in v1.12.37

func (s CreateLoadBalancerInput) String() string

String returns the string representation

func (*CreateLoadBalancerInput) Validate added in v1.12.37

func (s *CreateLoadBalancerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLoadBalancerOutput added in v1.12.37

type CreateLoadBalancerOutput struct {

	// An object containing information about the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerOutput) GoString added in v1.12.37

func (s CreateLoadBalancerOutput) GoString() string

GoString returns the string representation

func (*CreateLoadBalancerOutput) SetOperations added in v1.12.37

SetOperations sets the Operations field's value.

func (CreateLoadBalancerOutput) String added in v1.12.37

func (s CreateLoadBalancerOutput) String() string

String returns the string representation

type CreateLoadBalancerTlsCertificateInput added in v1.12.37

type CreateLoadBalancerTlsCertificateInput struct {

	// 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 `locationName:"certificateAlternativeNames" type:"list"`

	// The domain name (e.g., example.com) for your SSL/TLS certificate.
	//
	// CertificateDomainName is a required field
	CertificateDomainName *string `locationName:"certificateDomainName" type:"string" required:"true"`

	// The SSL/TLS certificate name.
	//
	// You can have up to 10 certificates in your account at one time. Each Lightsail
	// load balancer can have up to 2 certificates associated with it at one time.
	// There is also an overall limit to the number of certificates that can be
	// issue in a 365-day period. For more information, see Limits (http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html).
	//
	// CertificateName is a required field
	CertificateName *string `locationName:"certificateName" type:"string" required:"true"`

	// The load balancer name where you want to create the SSL/TLS certificate.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerTlsCertificateInput) GoString added in v1.12.37

GoString returns the string representation

func (*CreateLoadBalancerTlsCertificateInput) SetCertificateAlternativeNames added in v1.12.37

SetCertificateAlternativeNames sets the CertificateAlternativeNames field's value.

func (*CreateLoadBalancerTlsCertificateInput) SetCertificateDomainName added in v1.12.37

SetCertificateDomainName sets the CertificateDomainName field's value.

func (*CreateLoadBalancerTlsCertificateInput) SetCertificateName added in v1.12.37

SetCertificateName sets the CertificateName field's value.

func (*CreateLoadBalancerTlsCertificateInput) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*CreateLoadBalancerTlsCertificateInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateLoadBalancerTlsCertificateInput) String added in v1.12.37

String returns the string representation

func (*CreateLoadBalancerTlsCertificateInput) Validate added in v1.12.37

Validate inspects the fields of the type to determine if they are valid.

type CreateLoadBalancerTlsCertificateOutput added in v1.12.37

type CreateLoadBalancerTlsCertificateOutput struct {

	// An object containing information about the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerTlsCertificateOutput) GoString added in v1.12.37

GoString returns the string representation

func (*CreateLoadBalancerTlsCertificateOutput) SetOperations added in v1.12.37

SetOperations sets the Operations field's value.

func (CreateLoadBalancerTlsCertificateOutput) String added in v1.12.37

String returns the string representation

type CreateRelationalDatabaseFromSnapshotInput added in v1.99.0

type CreateRelationalDatabaseFromSnapshotInput struct {

	// 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 `locationName:"availabilityZone" type:"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 `locationName:"publiclyAccessible" type:"boolean"`

	// 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 `locationName:"relationalDatabaseBundleId" type:"string"`

	// 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.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`

	// The name of the database snapshot from which to create your new database.
	RelationalDatabaseSnapshotName *string `locationName:"relationalDatabaseSnapshotName" type:"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 Universal Coordinated 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 `locationName:"restoreTime" type:"timestamp"`

	// The name of the source database.
	SourceRelationalDatabaseName *string `locationName:"sourceRelationalDatabaseName" type:"string"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`

	// 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 `locationName:"useLatestRestorableTime" type:"boolean"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseFromSnapshotInput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateRelationalDatabaseFromSnapshotInput) SetAvailabilityZone added in v1.99.0

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetPubliclyAccessible added in v1.99.0

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetRelationalDatabaseBundleId added in v1.99.0

SetRelationalDatabaseBundleId sets the RelationalDatabaseBundleId field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetRelationalDatabaseSnapshotName added in v1.99.0

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetRestoreTime added in v1.99.0

SetRestoreTime sets the RestoreTime field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetSourceRelationalDatabaseName added in v1.99.0

SetSourceRelationalDatabaseName sets the SourceRelationalDatabaseName field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetUseLatestRestorableTime added in v1.99.0

SetUseLatestRestorableTime sets the UseLatestRestorableTime field's value.

func (CreateRelationalDatabaseFromSnapshotInput) String added in v1.99.0

String returns the string representation

func (*CreateRelationalDatabaseFromSnapshotInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type CreateRelationalDatabaseFromSnapshotOutput added in v1.99.0

type CreateRelationalDatabaseFromSnapshotOutput struct {

	// An object describing the result of your create relational database from snapshot
	// request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseFromSnapshotOutput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateRelationalDatabaseFromSnapshotOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (CreateRelationalDatabaseFromSnapshotOutput) String added in v1.99.0

String returns the string representation

type CreateRelationalDatabaseInput added in v1.99.0

type CreateRelationalDatabaseInput struct {

	// 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 `locationName:"availabilityZone" type:"string"`

	// 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
	//
	// MasterDatabaseName is a required field
	MasterDatabaseName *string `locationName:"masterDatabaseName" type:"string" required:"true"`

	// 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 `locationName:"masterUserPassword" type:"string" sensitive:"true"`

	// 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.
	//
	// MasterUsername is a required field
	MasterUsername *string `locationName:"masterUsername" type:"string" required:"true"`

	// 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 Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `locationName:"preferredBackupWindow" type:"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 Universal Coordinated Time (UTC).
	//
	//    * Example: Tue:17:00-Tue:17:30
	PreferredMaintenanceWindow *string `locationName:"preferredMaintenanceWindow" type:"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 `locationName:"publiclyAccessible" type:"boolean"`

	// 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.
	//
	// RelationalDatabaseBlueprintId is a required field
	RelationalDatabaseBlueprintId *string `locationName:"relationalDatabaseBlueprintId" type:"string" required:"true"`

	// The bundle ID for your new database. A bundle describes the performance specifications
	// for your database.
	//
	// You can get a list of database bundle IDs by using the get relational database
	// bundles operation.
	//
	// RelationalDatabaseBundleId is a required field
	RelationalDatabaseBundleId *string `locationName:"relationalDatabaseBundleId" type:"string" required:"true"`

	// 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.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseInput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateRelationalDatabaseInput) SetAvailabilityZone added in v1.99.0

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateRelationalDatabaseInput) SetMasterDatabaseName added in v1.99.0

SetMasterDatabaseName sets the MasterDatabaseName field's value.

func (*CreateRelationalDatabaseInput) SetMasterUserPassword added in v1.99.0

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*CreateRelationalDatabaseInput) SetMasterUsername added in v1.99.0

SetMasterUsername sets the MasterUsername field's value.

func (*CreateRelationalDatabaseInput) SetPreferredBackupWindow added in v1.99.0

func (s *CreateRelationalDatabaseInput) SetPreferredBackupWindow(v string) *CreateRelationalDatabaseInput

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*CreateRelationalDatabaseInput) SetPreferredMaintenanceWindow added in v1.99.0

func (s *CreateRelationalDatabaseInput) SetPreferredMaintenanceWindow(v string) *CreateRelationalDatabaseInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateRelationalDatabaseInput) SetPubliclyAccessible added in v1.99.0

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateRelationalDatabaseInput) SetRelationalDatabaseBlueprintId added in v1.99.0

func (s *CreateRelationalDatabaseInput) SetRelationalDatabaseBlueprintId(v string) *CreateRelationalDatabaseInput

SetRelationalDatabaseBlueprintId sets the RelationalDatabaseBlueprintId field's value.

func (*CreateRelationalDatabaseInput) SetRelationalDatabaseBundleId added in v1.99.0

func (s *CreateRelationalDatabaseInput) SetRelationalDatabaseBundleId(v string) *CreateRelationalDatabaseInput

SetRelationalDatabaseBundleId sets the RelationalDatabaseBundleId field's value.

func (*CreateRelationalDatabaseInput) SetRelationalDatabaseName added in v1.99.0

func (s *CreateRelationalDatabaseInput) SetRelationalDatabaseName(v string) *CreateRelationalDatabaseInput

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*CreateRelationalDatabaseInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateRelationalDatabaseInput) String added in v1.99.0

String returns the string representation

func (*CreateRelationalDatabaseInput) Validate added in v1.99.0

func (s *CreateRelationalDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateRelationalDatabaseOutput added in v1.99.0

type CreateRelationalDatabaseOutput struct {

	// An object describing the result of your create relational database request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseOutput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateRelationalDatabaseOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (CreateRelationalDatabaseOutput) String added in v1.99.0

String returns the string representation

type CreateRelationalDatabaseSnapshotInput added in v1.99.0

type CreateRelationalDatabaseSnapshotInput struct {

	// The name of the database on which to base your new snapshot.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`

	// The name for your new database snapshot.
	//
	// Constraints:
	//
	//    * Must contain from 2 to 255 alphanumeric characters, or hyphens.
	//
	//    * The first and last character must be a letter or number.
	//
	// RelationalDatabaseSnapshotName is a required field
	RelationalDatabaseSnapshotName *string `locationName:"relationalDatabaseSnapshotName" type:"string" required:"true"`

	// The tag keys and optional values to add to the resource during create.
	//
	// To tag a resource after it has been created, see the tag resource operation.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseSnapshotInput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateRelationalDatabaseSnapshotInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*CreateRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName added in v1.99.0

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (*CreateRelationalDatabaseSnapshotInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateRelationalDatabaseSnapshotInput) String added in v1.99.0

String returns the string representation

func (*CreateRelationalDatabaseSnapshotInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type CreateRelationalDatabaseSnapshotOutput added in v1.99.0

type CreateRelationalDatabaseSnapshotOutput struct {

	// An object describing the result of your create relational database snapshot
	// request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseSnapshotOutput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateRelationalDatabaseSnapshotOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (CreateRelationalDatabaseSnapshotOutput) String added in v1.99.0

String returns the string representation

type DeleteDiskInput added in v1.12.27

type DeleteDiskInput struct {

	// The unique name of the disk you want to delete (e.g., my-disk).
	//
	// DiskName is a required field
	DiskName *string `locationName:"diskName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDiskInput) GoString added in v1.12.27

func (s DeleteDiskInput) GoString() string

GoString returns the string representation

func (*DeleteDiskInput) SetDiskName added in v1.12.27

func (s *DeleteDiskInput) SetDiskName(v string) *DeleteDiskInput

SetDiskName sets the DiskName field's value.

func (DeleteDiskInput) String added in v1.12.27

func (s DeleteDiskInput) String() string

String returns the string representation

func (*DeleteDiskInput) Validate added in v1.12.27

func (s *DeleteDiskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDiskOutput added in v1.12.27

type DeleteDiskOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteDiskOutput) GoString added in v1.12.27

func (s DeleteDiskOutput) GoString() string

GoString returns the string representation

func (*DeleteDiskOutput) SetOperations added in v1.12.27

func (s *DeleteDiskOutput) SetOperations(v []*Operation) *DeleteDiskOutput

SetOperations sets the Operations field's value.

func (DeleteDiskOutput) String added in v1.12.27

func (s DeleteDiskOutput) String() string

String returns the string representation

type DeleteDiskSnapshotInput added in v1.12.27

type DeleteDiskSnapshotInput struct {

	// The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).
	//
	// DiskSnapshotName is a required field
	DiskSnapshotName *string `locationName:"diskSnapshotName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDiskSnapshotInput) GoString added in v1.12.27

func (s DeleteDiskSnapshotInput) GoString() string

GoString returns the string representation

func (*DeleteDiskSnapshotInput) SetDiskSnapshotName added in v1.12.27

func (s *DeleteDiskSnapshotInput) SetDiskSnapshotName(v string) *DeleteDiskSnapshotInput

SetDiskSnapshotName sets the DiskSnapshotName field's value.

func (DeleteDiskSnapshotInput) String added in v1.12.27

func (s DeleteDiskSnapshotInput) String() string

String returns the string representation

func (*DeleteDiskSnapshotInput) Validate added in v1.12.27

func (s *DeleteDiskSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDiskSnapshotOutput added in v1.12.27

type DeleteDiskSnapshotOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteDiskSnapshotOutput) GoString added in v1.12.27

func (s DeleteDiskSnapshotOutput) GoString() string

GoString returns the string representation

func (*DeleteDiskSnapshotOutput) SetOperations added in v1.12.27

SetOperations sets the Operations field's value.

func (DeleteDiskSnapshotOutput) String added in v1.12.27

func (s DeleteDiskSnapshotOutput) String() string

String returns the string representation

type DeleteDomainEntryInput

type DeleteDomainEntryInput struct {

	// An array of key-value pairs containing information about your domain entries.
	//
	// DomainEntry is a required field
	DomainEntry *DomainEntry `locationName:"domainEntry" type:"structure" required:"true"`

	// The name of the domain entry to delete.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDomainEntryInput) GoString

func (s DeleteDomainEntryInput) GoString() string

GoString returns the string representation

func (*DeleteDomainEntryInput) SetDomainEntry

SetDomainEntry sets the DomainEntry field's value.

func (*DeleteDomainEntryInput) SetDomainName

SetDomainName sets the DomainName field's value.

func (DeleteDomainEntryInput) String

func (s DeleteDomainEntryInput) String() string

String returns the string representation

func (*DeleteDomainEntryInput) Validate

func (s *DeleteDomainEntryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDomainEntryOutput

type DeleteDomainEntryOutput struct {

	// An array of key-value pairs containing information about the results of your
	// delete domain entry request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDomainEntryOutput) GoString

func (s DeleteDomainEntryOutput) GoString() string

GoString returns the string representation

func (*DeleteDomainEntryOutput) SetOperation

SetOperation sets the Operation field's value.

func (DeleteDomainEntryOutput) String

func (s DeleteDomainEntryOutput) String() string

String returns the string representation

type DeleteDomainInput

type DeleteDomainInput struct {

	// The specific domain name to delete.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDomainInput) GoString

func (s DeleteDomainInput) GoString() string

GoString returns the string representation

func (*DeleteDomainInput) SetDomainName

func (s *DeleteDomainInput) SetDomainName(v string) *DeleteDomainInput

SetDomainName sets the DomainName field's value.

func (DeleteDomainInput) String

func (s DeleteDomainInput) String() string

String returns the string representation

func (*DeleteDomainInput) Validate

func (s *DeleteDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDomainOutput

type DeleteDomainOutput struct {

	// An array of key-value pairs containing information about the results of your
	// delete domain request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDomainOutput) GoString

func (s DeleteDomainOutput) GoString() string

GoString returns the string representation

func (*DeleteDomainOutput) SetOperation

func (s *DeleteDomainOutput) SetOperation(v *Operation) *DeleteDomainOutput

SetOperation sets the Operation field's value.

func (DeleteDomainOutput) String

func (s DeleteDomainOutput) String() string

String returns the string representation

type DeleteInstanceInput

type DeleteInstanceInput struct {

	// The name of the instance to delete.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInstanceInput) GoString

func (s DeleteInstanceInput) GoString() string

GoString returns the string representation

func (*DeleteInstanceInput) SetInstanceName

func (s *DeleteInstanceInput) SetInstanceName(v string) *DeleteInstanceInput

SetInstanceName sets the InstanceName field's value.

func (DeleteInstanceInput) String

func (s DeleteInstanceInput) String() string

String returns the string representation

func (*DeleteInstanceInput) Validate

func (s *DeleteInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteInstanceOutput

type DeleteInstanceOutput struct {

	// An array of key-value pairs containing information about the results of your
	// delete instance request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteInstanceOutput) GoString

func (s DeleteInstanceOutput) GoString() string

GoString returns the string representation

func (*DeleteInstanceOutput) SetOperations

func (s *DeleteInstanceOutput) SetOperations(v []*Operation) *DeleteInstanceOutput

SetOperations sets the Operations field's value.

func (DeleteInstanceOutput) String

func (s DeleteInstanceOutput) String() string

String returns the string representation

type DeleteInstanceSnapshotInput

type DeleteInstanceSnapshotInput struct {

	// The name of the snapshot to delete.
	//
	// InstanceSnapshotName is a required field
	InstanceSnapshotName *string `locationName:"instanceSnapshotName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInstanceSnapshotInput) GoString

func (s DeleteInstanceSnapshotInput) GoString() string

GoString returns the string representation

func (*DeleteInstanceSnapshotInput) SetInstanceSnapshotName

func (s *DeleteInstanceSnapshotInput) SetInstanceSnapshotName(v string) *DeleteInstanceSnapshotInput

SetInstanceSnapshotName sets the InstanceSnapshotName field's value.

func (DeleteInstanceSnapshotInput) String

String returns the string representation

func (*DeleteInstanceSnapshotInput) Validate

func (s *DeleteInstanceSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteInstanceSnapshotOutput

type DeleteInstanceSnapshotOutput struct {

	// An array of key-value pairs containing information about the results of your
	// delete instance snapshot request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteInstanceSnapshotOutput) GoString

func (s DeleteInstanceSnapshotOutput) GoString() string

GoString returns the string representation

func (*DeleteInstanceSnapshotOutput) SetOperations

SetOperations sets the Operations field's value.

func (DeleteInstanceSnapshotOutput) String

String returns the string representation

type DeleteKeyPairInput

type DeleteKeyPairInput struct {

	// The name of the key pair to delete.
	//
	// KeyPairName is a required field
	KeyPairName *string `locationName:"keyPairName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteKeyPairInput) GoString

func (s DeleteKeyPairInput) GoString() string

GoString returns the string representation

func (*DeleteKeyPairInput) SetKeyPairName

func (s *DeleteKeyPairInput) SetKeyPairName(v string) *DeleteKeyPairInput

SetKeyPairName sets the KeyPairName field's value.

func (DeleteKeyPairInput) String

func (s DeleteKeyPairInput) String() string

String returns the string representation

func (*DeleteKeyPairInput) Validate

func (s *DeleteKeyPairInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKeyPairOutput

type DeleteKeyPairOutput struct {

	// An array of key-value pairs containing information about the results of your
	// delete key pair request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteKeyPairOutput) GoString

func (s DeleteKeyPairOutput) GoString() string

GoString returns the string representation

func (*DeleteKeyPairOutput) SetOperation

func (s *DeleteKeyPairOutput) SetOperation(v *Operation) *DeleteKeyPairOutput

SetOperation sets the Operation field's value.

func (DeleteKeyPairOutput) String

func (s DeleteKeyPairOutput) String() string

String returns the string representation

type DeleteKnownHostKeysInput added in v1.99.0

type DeleteKnownHostKeysInput struct {

	// The name of the instance for which you want to reset the host key or certificate.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteKnownHostKeysInput) GoString added in v1.99.0

func (s DeleteKnownHostKeysInput) GoString() string

GoString returns the string representation

func (*DeleteKnownHostKeysInput) SetInstanceName added in v1.99.0

SetInstanceName sets the InstanceName field's value.

func (DeleteKnownHostKeysInput) String added in v1.99.0

func (s DeleteKnownHostKeysInput) String() string

String returns the string representation

func (*DeleteKnownHostKeysInput) Validate added in v1.99.0

func (s *DeleteKnownHostKeysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKnownHostKeysOutput added in v1.99.0

type DeleteKnownHostKeysOutput struct {

	// A list of objects describing the API operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteKnownHostKeysOutput) GoString added in v1.99.0

func (s DeleteKnownHostKeysOutput) GoString() string

GoString returns the string representation

func (*DeleteKnownHostKeysOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (DeleteKnownHostKeysOutput) String added in v1.99.0

func (s DeleteKnownHostKeysOutput) String() string

String returns the string representation

type DeleteLoadBalancerInput added in v1.12.37

type DeleteLoadBalancerInput struct {

	// The name of the load balancer you want to delete.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLoadBalancerInput) GoString added in v1.12.37

func (s DeleteLoadBalancerInput) GoString() string

GoString returns the string representation

func (*DeleteLoadBalancerInput) SetLoadBalancerName added in v1.12.37

func (s *DeleteLoadBalancerInput) SetLoadBalancerName(v string) *DeleteLoadBalancerInput

SetLoadBalancerName sets the LoadBalancerName field's value.

func (DeleteLoadBalancerInput) String added in v1.12.37

func (s DeleteLoadBalancerInput) String() string

String returns the string representation

func (*DeleteLoadBalancerInput) Validate added in v1.12.37

func (s *DeleteLoadBalancerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLoadBalancerOutput added in v1.12.37

type DeleteLoadBalancerOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteLoadBalancerOutput) GoString added in v1.12.37

func (s DeleteLoadBalancerOutput) GoString() string

GoString returns the string representation

func (*DeleteLoadBalancerOutput) SetOperations added in v1.12.37

SetOperations sets the Operations field's value.

func (DeleteLoadBalancerOutput) String added in v1.12.37

func (s DeleteLoadBalancerOutput) String() string

String returns the string representation

type DeleteLoadBalancerTlsCertificateInput added in v1.12.37

type DeleteLoadBalancerTlsCertificateInput struct {

	// The SSL/TLS certificate name.
	//
	// CertificateName is a required field
	CertificateName *string `locationName:"certificateName" type:"string" required:"true"`

	// 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 `locationName:"force" type:"boolean"`

	// The load balancer name.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLoadBalancerTlsCertificateInput) GoString added in v1.12.37

GoString returns the string representation

func (*DeleteLoadBalancerTlsCertificateInput) SetCertificateName added in v1.12.37

SetCertificateName sets the CertificateName field's value.

func (*DeleteLoadBalancerTlsCertificateInput) SetForce added in v1.12.37

SetForce sets the Force field's value.

func (*DeleteLoadBalancerTlsCertificateInput) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (DeleteLoadBalancerTlsCertificateInput) String added in v1.12.37

String returns the string representation

func (*DeleteLoadBalancerTlsCertificateInput) Validate added in v1.12.37

Validate inspects the fields of the type to determine if they are valid.

type DeleteLoadBalancerTlsCertificateOutput added in v1.12.37

type DeleteLoadBalancerTlsCertificateOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteLoadBalancerTlsCertificateOutput) GoString added in v1.12.37

GoString returns the string representation

func (*DeleteLoadBalancerTlsCertificateOutput) SetOperations added in v1.12.37

SetOperations sets the Operations field's value.

func (DeleteLoadBalancerTlsCertificateOutput) String added in v1.12.37

String returns the string representation

type DeleteRelationalDatabaseInput added in v1.99.0

type DeleteRelationalDatabaseInput struct {

	// 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 `locationName:"finalRelationalDatabaseSnapshotName" type:"string"`

	// The name of the database that you are deleting.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`

	// 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 `locationName:"skipFinalSnapshot" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteRelationalDatabaseInput) GoString added in v1.99.0

GoString returns the string representation

func (*DeleteRelationalDatabaseInput) SetFinalRelationalDatabaseSnapshotName added in v1.99.0

func (s *DeleteRelationalDatabaseInput) SetFinalRelationalDatabaseSnapshotName(v string) *DeleteRelationalDatabaseInput

SetFinalRelationalDatabaseSnapshotName sets the FinalRelationalDatabaseSnapshotName field's value.

func (*DeleteRelationalDatabaseInput) SetRelationalDatabaseName added in v1.99.0

func (s *DeleteRelationalDatabaseInput) SetRelationalDatabaseName(v string) *DeleteRelationalDatabaseInput

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*DeleteRelationalDatabaseInput) SetSkipFinalSnapshot added in v1.99.0

SetSkipFinalSnapshot sets the SkipFinalSnapshot field's value.

func (DeleteRelationalDatabaseInput) String added in v1.99.0

String returns the string representation

func (*DeleteRelationalDatabaseInput) Validate added in v1.99.0

func (s *DeleteRelationalDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRelationalDatabaseOutput added in v1.99.0

type DeleteRelationalDatabaseOutput struct {

	// An object describing the result of your delete relational database request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteRelationalDatabaseOutput) GoString added in v1.99.0

GoString returns the string representation

func (*DeleteRelationalDatabaseOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (DeleteRelationalDatabaseOutput) String added in v1.99.0

String returns the string representation

type DeleteRelationalDatabaseSnapshotInput added in v1.99.0

type DeleteRelationalDatabaseSnapshotInput struct {

	// The name of the database snapshot that you are deleting.
	//
	// RelationalDatabaseSnapshotName is a required field
	RelationalDatabaseSnapshotName *string `locationName:"relationalDatabaseSnapshotName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRelationalDatabaseSnapshotInput) GoString added in v1.99.0

GoString returns the string representation

func (*DeleteRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName added in v1.99.0

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (DeleteRelationalDatabaseSnapshotInput) String added in v1.99.0

String returns the string representation

func (*DeleteRelationalDatabaseSnapshotInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type DeleteRelationalDatabaseSnapshotOutput added in v1.99.0

type DeleteRelationalDatabaseSnapshotOutput struct {

	// An object describing the result of your delete relational database snapshot
	// request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteRelationalDatabaseSnapshotOutput) GoString added in v1.99.0

GoString returns the string representation

func (*DeleteRelationalDatabaseSnapshotOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (DeleteRelationalDatabaseSnapshotOutput) String added in v1.99.0

String returns the string representation

type DestinationInfo added in v1.99.0

type DestinationInfo struct {

	// The ID of the resource created at the destination.
	Id *string `locationName:"id" type:"string"`

	// The destination service of the record.
	Service *string `locationName:"service" type:"string"`
	// contains filtered or unexported fields
}

Describes the destination of a record.

func (DestinationInfo) GoString added in v1.99.0

func (s DestinationInfo) GoString() string

GoString returns the string representation

func (*DestinationInfo) SetId added in v1.99.0

func (s *DestinationInfo) SetId(v string) *DestinationInfo

SetId sets the Id field's value.

func (*DestinationInfo) SetService added in v1.99.0

func (s *DestinationInfo) SetService(v string) *DestinationInfo

SetService sets the Service field's value.

func (DestinationInfo) String added in v1.99.0

func (s DestinationInfo) String() string

String returns the string representation

type DetachDiskInput added in v1.12.27

type DetachDiskInput struct {

	// The unique name of the disk you want to detach from your instance (e.g.,
	// my-disk).
	//
	// DiskName is a required field
	DiskName *string `locationName:"diskName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetachDiskInput) GoString added in v1.12.27

func (s DetachDiskInput) GoString() string

GoString returns the string representation

func (*DetachDiskInput) SetDiskName added in v1.12.27

func (s *DetachDiskInput) SetDiskName(v string) *DetachDiskInput

SetDiskName sets the DiskName field's value.

func (DetachDiskInput) String added in v1.12.27

func (s DetachDiskInput) String() string

String returns the string representation

func (*DetachDiskInput) Validate added in v1.12.27

func (s *DetachDiskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetachDiskOutput added in v1.12.27

type DetachDiskOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DetachDiskOutput) GoString added in v1.12.27

func (s DetachDiskOutput) GoString() string

GoString returns the string representation

func (*DetachDiskOutput) SetOperations added in v1.12.27

func (s *DetachDiskOutput) SetOperations(v []*Operation) *DetachDiskOutput

SetOperations sets the Operations field's value.

func (DetachDiskOutput) String added in v1.12.27

func (s DetachDiskOutput) String() string

String returns the string representation

type DetachInstancesFromLoadBalancerInput added in v1.12.37

type DetachInstancesFromLoadBalancerInput struct {

	// An array of strings containing the names of the instances you want to detach
	// from the load balancer.
	//
	// InstanceNames is a required field
	InstanceNames []*string `locationName:"instanceNames" type:"list" required:"true"`

	// The name of the Lightsail load balancer.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetachInstancesFromLoadBalancerInput) GoString added in v1.12.37

GoString returns the string representation

func (*DetachInstancesFromLoadBalancerInput) SetInstanceNames added in v1.12.37

SetInstanceNames sets the InstanceNames field's value.

func (*DetachInstancesFromLoadBalancerInput) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (DetachInstancesFromLoadBalancerInput) String added in v1.12.37

String returns the string representation

func (*DetachInstancesFromLoadBalancerInput) Validate added in v1.12.37

Validate inspects the fields of the type to determine if they are valid.

type DetachInstancesFromLoadBalancerOutput added in v1.12.37

type DetachInstancesFromLoadBalancerOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DetachInstancesFromLoadBalancerOutput) GoString added in v1.12.37

GoString returns the string representation

func (*DetachInstancesFromLoadBalancerOutput) SetOperations added in v1.12.37

SetOperations sets the Operations field's value.

func (DetachInstancesFromLoadBalancerOutput) String added in v1.12.37

String returns the string representation

type DetachStaticIpInput

type DetachStaticIpInput struct {

	// The name of the static IP to detach from the instance.
	//
	// StaticIpName is a required field
	StaticIpName *string `locationName:"staticIpName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetachStaticIpInput) GoString

func (s DetachStaticIpInput) GoString() string

GoString returns the string representation

func (*DetachStaticIpInput) SetStaticIpName

func (s *DetachStaticIpInput) SetStaticIpName(v string) *DetachStaticIpInput

SetStaticIpName sets the StaticIpName field's value.

func (DetachStaticIpInput) String

func (s DetachStaticIpInput) String() string

String returns the string representation

func (*DetachStaticIpInput) Validate

func (s *DetachStaticIpInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetachStaticIpOutput

type DetachStaticIpOutput struct {

	// An array of key-value pairs containing information about the results of your
	// detach static IP request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DetachStaticIpOutput) GoString

func (s DetachStaticIpOutput) GoString() string

GoString returns the string representation

func (*DetachStaticIpOutput) SetOperations

func (s *DetachStaticIpOutput) SetOperations(v []*Operation) *DetachStaticIpOutput

SetOperations sets the Operations field's value.

func (DetachStaticIpOutput) String

func (s DetachStaticIpOutput) String() string

String returns the string representation

type Disk

type Disk struct {

	// The Amazon Resource Name (ARN) of the disk.
	Arn *string `locationName:"arn" type:"string"`

	// The resources to which the disk is attached.
	AttachedTo *string `locationName:"attachedTo" type:"string"`

	// (Deprecated) The attachment state of the disk.
	//
	// In releases prior to November 14, 2017, this parameter returned attached
	// for system disks in the API response. It is now deprecated, but still included
	// in the response. Use isAttached instead.
	//
	// Deprecated: AttachmentState has been deprecated
	AttachmentState *string `locationName:"attachmentState" deprecated:"true" type:"string"`

	// The date when the disk was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// (Deprecated) The number of GB in use by the disk.
	//
	// In releases prior to November 14, 2017, this parameter was not included in
	// the API response. It is now deprecated.
	//
	// Deprecated: GbInUse has been deprecated
	GbInUse *int64 `locationName:"gbInUse" deprecated:"true" type:"integer"`

	// The input/output operations per second (IOPS) of the disk.
	Iops *int64 `locationName:"iops" type:"integer"`

	// A Boolean value indicating whether the disk is attached.
	IsAttached *bool `locationName:"isAttached" type:"boolean"`

	// A Boolean value indicating whether this disk is a system disk (has an operating
	// system loaded on it).
	IsSystemDisk *bool `locationName:"isSystemDisk" type:"boolean"`

	// The AWS Region and Availability Zone where the disk is located.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The unique name of the disk.
	Name *string `locationName:"name" type:"string"`

	// The disk path.
	Path *string `locationName:"path" type:"string"`

	// The Lightsail resource type (e.g., Disk).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The size of the disk in GB.
	SizeInGb *int64 `locationName:"sizeInGb" type:"integer"`

	// Describes the status of the disk.
	State *string `locationName:"state" type:"string" enum:"DiskState"`

	// The support code. Include this code in your email to support when you have
	// questions about an instance or another resource in Lightsail. This code enables
	// our support team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a system disk or an block storage disk.

func (Disk) GoString

func (s Disk) GoString() string

GoString returns the string representation

func (*Disk) SetArn

func (s *Disk) SetArn(v string) *Disk

SetArn sets the Arn field's value.

func (*Disk) SetAttachedTo

func (s *Disk) SetAttachedTo(v string) *Disk

SetAttachedTo sets the AttachedTo field's value.

func (*Disk) SetAttachmentState

func (s *Disk) SetAttachmentState(v string) *Disk

SetAttachmentState sets the AttachmentState field's value.

func (*Disk) SetCreatedAt

func (s *Disk) SetCreatedAt(v time.Time) *Disk

SetCreatedAt sets the CreatedAt field's value.

func (*Disk) SetGbInUse

func (s *Disk) SetGbInUse(v int64) *Disk

SetGbInUse sets the GbInUse field's value.

func (*Disk) SetIops

func (s *Disk) SetIops(v int64) *Disk

SetIops sets the Iops field's value.

func (*Disk) SetIsAttached

func (s *Disk) SetIsAttached(v bool) *Disk

SetIsAttached sets the IsAttached field's value.

func (*Disk) SetIsSystemDisk

func (s *Disk) SetIsSystemDisk(v bool) *Disk

SetIsSystemDisk sets the IsSystemDisk field's value.

func (*Disk) SetLocation

func (s *Disk) SetLocation(v *ResourceLocation) *Disk

SetLocation sets the Location field's value.

func (*Disk) SetName

func (s *Disk) SetName(v string) *Disk

SetName sets the Name field's value.

func (*Disk) SetPath

func (s *Disk) SetPath(v string) *Disk

SetPath sets the Path field's value.

func (*Disk) SetResourceType

func (s *Disk) SetResourceType(v string) *Disk

SetResourceType sets the ResourceType field's value.

func (*Disk) SetSizeInGb

func (s *Disk) SetSizeInGb(v int64) *Disk

SetSizeInGb sets the SizeInGb field's value.

func (*Disk) SetState added in v1.12.27

func (s *Disk) SetState(v string) *Disk

SetState sets the State field's value.

func (*Disk) SetSupportCode

func (s *Disk) SetSupportCode(v string) *Disk

SetSupportCode sets the SupportCode field's value.

func (*Disk) SetTags added in v1.99.0

func (s *Disk) SetTags(v []*Tag) *Disk

SetTags sets the Tags field's value.

func (Disk) String

func (s Disk) String() string

String returns the string representation

type DiskInfo added in v1.99.0

type DiskInfo struct {

	// A Boolean value indicating whether this disk is a system disk (has an operating
	// system loaded on it).
	IsSystemDisk *bool `locationName:"isSystemDisk" type:"boolean"`

	// The disk name.
	Name *string `locationName:"name" type:"string"`

	// The disk path.
	Path *string `locationName:"path" type:"string"`

	// The size of the disk in GB (e.g., 32).
	SizeInGb *int64 `locationName:"sizeInGb" type:"integer"`
	// contains filtered or unexported fields
}

Describes a disk.

func (DiskInfo) GoString added in v1.99.0

func (s DiskInfo) GoString() string

GoString returns the string representation

func (*DiskInfo) SetIsSystemDisk added in v1.99.0

func (s *DiskInfo) SetIsSystemDisk(v bool) *DiskInfo

SetIsSystemDisk sets the IsSystemDisk field's value.

func (*DiskInfo) SetName added in v1.99.0

func (s *DiskInfo) SetName(v string) *DiskInfo

SetName sets the Name field's value.

func (*DiskInfo) SetPath added in v1.99.0

func (s *DiskInfo) SetPath(v string) *DiskInfo

SetPath sets the Path field's value.

func (*DiskInfo) SetSizeInGb added in v1.99.0

func (s *DiskInfo) SetSizeInGb(v int64) *DiskInfo

SetSizeInGb sets the SizeInGb field's value.

func (DiskInfo) String added in v1.99.0

func (s DiskInfo) String() string

String returns the string representation

type DiskMap added in v1.12.27

type DiskMap struct {

	// The new disk name (e.g., my-new-disk).
	NewDiskName *string `locationName:"newDiskName" type:"string"`

	// The original disk path exposed to the instance (for example, /dev/sdh).
	OriginalDiskPath *string `locationName:"originalDiskPath" type:"string"`
	// contains filtered or unexported fields
}

Describes a block storage disk mapping.

func (DiskMap) GoString added in v1.12.27

func (s DiskMap) GoString() string

GoString returns the string representation

func (*DiskMap) SetNewDiskName added in v1.12.27

func (s *DiskMap) SetNewDiskName(v string) *DiskMap

SetNewDiskName sets the NewDiskName field's value.

func (*DiskMap) SetOriginalDiskPath added in v1.12.27

func (s *DiskMap) SetOriginalDiskPath(v string) *DiskMap

SetOriginalDiskPath sets the OriginalDiskPath field's value.

func (DiskMap) String added in v1.12.27

func (s DiskMap) String() string

String returns the string representation

type DiskSnapshot added in v1.12.27

type DiskSnapshot struct {

	// The Amazon Resource Name (ARN) of the disk snapshot.
	Arn *string `locationName:"arn" type:"string"`

	// The date when the disk snapshot was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the source disk from which the disk snapshot
	// was created.
	FromDiskArn *string `locationName:"fromDiskArn" type:"string"`

	// The unique name of the source disk from which the disk snapshot was created.
	FromDiskName *string `locationName:"fromDiskName" type:"string"`

	// The Amazon Resource Name (ARN) of the source instance from which the disk
	// (system volume) snapshot was created.
	FromInstanceArn *string `locationName:"fromInstanceArn" type:"string"`

	// The unique name of the source instance from which the disk (system volume)
	// snapshot was created.
	FromInstanceName *string `locationName:"fromInstanceName" type:"string"`

	// The AWS Region and Availability Zone where the disk snapshot was created.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the disk snapshot (e.g., my-disk-snapshot).
	Name *string `locationName:"name" type:"string"`

	// The progress of the disk snapshot operation.
	Progress *string `locationName:"progress" type:"string"`

	// The Lightsail resource type (e.g., DiskSnapshot).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The size of the disk in GB.
	SizeInGb *int64 `locationName:"sizeInGb" type:"integer"`

	// The status of the disk snapshot operation.
	State *string `locationName:"state" type:"string" enum:"DiskSnapshotState"`

	// The support code. Include this code in your email to support when you have
	// questions about an instance or another resource in Lightsail. This code enables
	// our support team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a block storage disk snapshot.

func (DiskSnapshot) GoString added in v1.12.27

func (s DiskSnapshot) GoString() string

GoString returns the string representation

func (*DiskSnapshot) SetArn added in v1.12.27

func (s *DiskSnapshot) SetArn(v string) *DiskSnapshot

SetArn sets the Arn field's value.

func (*DiskSnapshot) SetCreatedAt added in v1.12.27

func (s *DiskSnapshot) SetCreatedAt(v time.Time) *DiskSnapshot

SetCreatedAt sets the CreatedAt field's value.

func (*DiskSnapshot) SetFromDiskArn added in v1.12.27

func (s *DiskSnapshot) SetFromDiskArn(v string) *DiskSnapshot

SetFromDiskArn sets the FromDiskArn field's value.

func (*DiskSnapshot) SetFromDiskName added in v1.12.27

func (s *DiskSnapshot) SetFromDiskName(v string) *DiskSnapshot

SetFromDiskName sets the FromDiskName field's value.

func (*DiskSnapshot) SetFromInstanceArn added in v1.99.0

func (s *DiskSnapshot) SetFromInstanceArn(v string) *DiskSnapshot

SetFromInstanceArn sets the FromInstanceArn field's value.

func (*DiskSnapshot) SetFromInstanceName added in v1.99.0

func (s *DiskSnapshot) SetFromInstanceName(v string) *DiskSnapshot

SetFromInstanceName sets the FromInstanceName field's value.

func (*DiskSnapshot) SetLocation added in v1.12.27

func (s *DiskSnapshot) SetLocation(v *ResourceLocation) *DiskSnapshot

SetLocation sets the Location field's value.

func (*DiskSnapshot) SetName added in v1.12.27

func (s *DiskSnapshot) SetName(v string) *DiskSnapshot

SetName sets the Name field's value.

func (*DiskSnapshot) SetProgress added in v1.12.27

func (s *DiskSnapshot) SetProgress(v string) *DiskSnapshot

SetProgress sets the Progress field's value.

func (*DiskSnapshot) SetResourceType added in v1.12.27

func (s *DiskSnapshot) SetResourceType(v string) *DiskSnapshot

SetResourceType sets the ResourceType field's value.

func (*DiskSnapshot) SetSizeInGb added in v1.12.27

func (s *DiskSnapshot) SetSizeInGb(v int64) *DiskSnapshot

SetSizeInGb sets the SizeInGb field's value.

func (*DiskSnapshot) SetState added in v1.12.27

func (s *DiskSnapshot) SetState(v string) *DiskSnapshot

SetState sets the State field's value.

func (*DiskSnapshot) SetSupportCode added in v1.12.27

func (s *DiskSnapshot) SetSupportCode(v string) *DiskSnapshot

SetSupportCode sets the SupportCode field's value.

func (*DiskSnapshot) SetTags added in v1.99.0

func (s *DiskSnapshot) SetTags(v []*Tag) *DiskSnapshot

SetTags sets the Tags field's value.

func (DiskSnapshot) String added in v1.12.27

func (s DiskSnapshot) String() string

String returns the string representation

type DiskSnapshotInfo added in v1.99.0

type DiskSnapshotInfo struct {

	// The size of the disk in GB (e.g., 32).
	SizeInGb *int64 `locationName:"sizeInGb" type:"integer"`
	// contains filtered or unexported fields
}

Describes a disk snapshot.

func (DiskSnapshotInfo) GoString added in v1.99.0

func (s DiskSnapshotInfo) GoString() string

GoString returns the string representation

func (*DiskSnapshotInfo) SetSizeInGb added in v1.99.0

func (s *DiskSnapshotInfo) SetSizeInGb(v int64) *DiskSnapshotInfo

SetSizeInGb sets the SizeInGb field's value.

func (DiskSnapshotInfo) String added in v1.99.0

func (s DiskSnapshotInfo) String() string

String returns the string representation

type Domain

type Domain struct {

	// The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
	Arn *string `locationName:"arn" type:"string"`

	// The date when the domain recordset was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// An array of key-value pairs containing information about the domain entries.
	DomainEntries []*DomainEntry `locationName:"domainEntries" type:"list"`

	// The AWS Region and Availability Zones where the domain recordset was created.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the domain.
	Name *string `locationName:"name" type:"string"`

	// The resource type.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The support code. Include this code in your email to support when you have
	// questions about an instance or another resource in Lightsail. This code enables
	// our support team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a domain where you are storing recordsets in Lightsail.

func (Domain) GoString

func (s Domain) GoString() string

GoString returns the string representation

func (*Domain) SetArn

func (s *Domain) SetArn(v string) *Domain

SetArn sets the Arn field's value.

func (*Domain) SetCreatedAt

func (s *Domain) SetCreatedAt(v time.Time) *Domain

SetCreatedAt sets the CreatedAt field's value.

func (*Domain) SetDomainEntries

func (s *Domain) SetDomainEntries(v []*DomainEntry) *Domain

SetDomainEntries sets the DomainEntries field's value.

func (*Domain) SetLocation

func (s *Domain) SetLocation(v *ResourceLocation) *Domain

SetLocation sets the Location field's value.

func (*Domain) SetName

func (s *Domain) SetName(v string) *Domain

SetName sets the Name field's value.

func (*Domain) SetResourceType

func (s *Domain) SetResourceType(v string) *Domain

SetResourceType sets the ResourceType field's value.

func (*Domain) SetSupportCode

func (s *Domain) SetSupportCode(v string) *Domain

SetSupportCode sets the SupportCode field's value.

func (*Domain) SetTags added in v1.99.0

func (s *Domain) SetTags(v []*Tag) *Domain

SetTags sets the Tags field's value.

func (Domain) String

func (s Domain) String() string

String returns the string representation

type DomainEntry

type DomainEntry struct {

	// The ID of the domain recordset entry.
	Id *string `locationName:"id" type:"string"`

	// When true, specifies whether the domain entry is an alias used by the Lightsail
	// load balancer. You can include an alias (A type) record in your request,
	// which points to a load balancer DNS name and routes traffic to your load
	// balancer
	IsAlias *bool `locationName:"isAlias" type:"boolean"`

	// The name of the domain.
	Name *string `locationName:"name" type:"string"`

	// (Deprecated) The options for the domain entry.
	//
	// In releases prior to November 29, 2017, this parameter was not included in
	// the API response. It is now deprecated.
	//
	// Deprecated: Options has been deprecated
	Options map[string]*string `locationName:"options" deprecated:"true" type:"map"`

	// The target AWS name server (e.g., ns-111.awsdns-22.com.).
	//
	// For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com.
	// Be sure to also set isAlias to true when setting up an A record for a load
	// balancer.
	Target *string `locationName:"target" type:"string"`

	// The type of domain entry, such as address (A), canonical name (CNAME), mail
	// exchanger (MX), name server (NS), start of authority (SOA), service locator
	// (SRV), or text (TXT).
	//
	// The following domain entry types can be used:
	//
	//    * A
	//
	//    * CNAME
	//
	//    * MX
	//
	//    * NS
	//
	//    * SOA
	//
	//    * SRV
	//
	//    * TXT
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

Describes a domain recordset entry.

func (DomainEntry) GoString

func (s DomainEntry) GoString() string

GoString returns the string representation

func (*DomainEntry) SetId

func (s *DomainEntry) SetId(v string) *DomainEntry

SetId sets the Id field's value.

func (*DomainEntry) SetIsAlias added in v1.12.37

func (s *DomainEntry) SetIsAlias(v bool) *DomainEntry

SetIsAlias sets the IsAlias field's value.

func (*DomainEntry) SetName

func (s *DomainEntry) SetName(v string) *DomainEntry

SetName sets the Name field's value.

func (*DomainEntry) SetOptions

func (s *DomainEntry) SetOptions(v map[string]*string) *DomainEntry

SetOptions sets the Options field's value.

func (*DomainEntry) SetTarget

func (s *DomainEntry) SetTarget(v string) *DomainEntry

SetTarget sets the Target field's value.

func (*DomainEntry) SetType

func (s *DomainEntry) SetType(v string) *DomainEntry

SetType sets the Type field's value.

func (DomainEntry) String

func (s DomainEntry) String() string

String returns the string representation

type DownloadDefaultKeyPairInput

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

func (DownloadDefaultKeyPairInput) GoString

func (s DownloadDefaultKeyPairInput) GoString() string

GoString returns the string representation

func (DownloadDefaultKeyPairInput) String

String returns the string representation

type DownloadDefaultKeyPairOutput

type DownloadDefaultKeyPairOutput struct {

	// A base64-encoded RSA private key.
	PrivateKeyBase64 *string `locationName:"privateKeyBase64" type:"string"`

	// A base64-encoded public key of the ssh-rsa type.
	PublicKeyBase64 *string `locationName:"publicKeyBase64" type:"string"`
	// contains filtered or unexported fields
}

func (DownloadDefaultKeyPairOutput) GoString

func (s DownloadDefaultKeyPairOutput) GoString() string

GoString returns the string representation

func (*DownloadDefaultKeyPairOutput) SetPrivateKeyBase64

SetPrivateKeyBase64 sets the PrivateKeyBase64 field's value.

func (*DownloadDefaultKeyPairOutput) SetPublicKeyBase64

SetPublicKeyBase64 sets the PublicKeyBase64 field's value.

func (DownloadDefaultKeyPairOutput) String

String returns the string representation

type ExportSnapshotInput added in v1.99.0

type ExportSnapshotInput struct {

	// The name of the instance or disk snapshot to be exported to Amazon EC2.
	//
	// SourceSnapshotName is a required field
	SourceSnapshotName *string `locationName:"sourceSnapshotName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExportSnapshotInput) GoString added in v1.99.0

func (s ExportSnapshotInput) GoString() string

GoString returns the string representation

func (*ExportSnapshotInput) SetSourceSnapshotName added in v1.99.0

func (s *ExportSnapshotInput) SetSourceSnapshotName(v string) *ExportSnapshotInput

SetSourceSnapshotName sets the SourceSnapshotName field's value.

func (ExportSnapshotInput) String added in v1.99.0

func (s ExportSnapshotInput) String() string

String returns the string representation

func (*ExportSnapshotInput) Validate added in v1.99.0

func (s *ExportSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportSnapshotOutput added in v1.99.0

type ExportSnapshotOutput struct {

	// A list of objects describing the API operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (ExportSnapshotOutput) GoString added in v1.99.0

func (s ExportSnapshotOutput) GoString() string

GoString returns the string representation

func (*ExportSnapshotOutput) SetOperations added in v1.99.0

func (s *ExportSnapshotOutput) SetOperations(v []*Operation) *ExportSnapshotOutput

SetOperations sets the Operations field's value.

func (ExportSnapshotOutput) String added in v1.99.0

func (s ExportSnapshotOutput) String() string

String returns the string representation

type ExportSnapshotRecord added in v1.99.0

type ExportSnapshotRecord struct {

	// The Amazon Resource Name (ARN) of the export snapshot record.
	Arn *string `locationName:"arn" type:"string"`

	// The date when the export snapshot record was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A list of objects describing the destination of the export snapshot record.
	DestinationInfo *DestinationInfo `locationName:"destinationInfo" type:"structure"`

	// The AWS Region and Availability Zone where the export snapshot record is
	// located.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The export snapshot record name.
	Name *string `locationName:"name" type:"string"`

	// The Lightsail resource type (e.g., ExportSnapshotRecord).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// A list of objects describing the source of the export snapshot record.
	SourceInfo *ExportSnapshotRecordSourceInfo `locationName:"sourceInfo" type:"structure"`

	// The state of the export snapshot record.
	State *string `locationName:"state" type:"string" enum:"RecordState"`
	// contains filtered or unexported fields
}

Describes an export snapshot record.

func (ExportSnapshotRecord) GoString added in v1.99.0

func (s ExportSnapshotRecord) GoString() string

GoString returns the string representation

func (*ExportSnapshotRecord) SetArn added in v1.99.0

SetArn sets the Arn field's value.

func (*ExportSnapshotRecord) SetCreatedAt added in v1.99.0

func (s *ExportSnapshotRecord) SetCreatedAt(v time.Time) *ExportSnapshotRecord

SetCreatedAt sets the CreatedAt field's value.

func (*ExportSnapshotRecord) SetDestinationInfo added in v1.99.0

func (s *ExportSnapshotRecord) SetDestinationInfo(v *DestinationInfo) *ExportSnapshotRecord

SetDestinationInfo sets the DestinationInfo field's value.

func (*ExportSnapshotRecord) SetLocation added in v1.99.0

SetLocation sets the Location field's value.

func (*ExportSnapshotRecord) SetName added in v1.99.0

SetName sets the Name field's value.

func (*ExportSnapshotRecord) SetResourceType added in v1.99.0

func (s *ExportSnapshotRecord) SetResourceType(v string) *ExportSnapshotRecord

SetResourceType sets the ResourceType field's value.

func (*ExportSnapshotRecord) SetSourceInfo added in v1.99.0

SetSourceInfo sets the SourceInfo field's value.

func (*ExportSnapshotRecord) SetState added in v1.99.0

SetState sets the State field's value.

func (ExportSnapshotRecord) String added in v1.99.0

func (s ExportSnapshotRecord) String() string

String returns the string representation

type ExportSnapshotRecordSourceInfo added in v1.99.0

type ExportSnapshotRecordSourceInfo struct {

	// The Amazon Resource Name (ARN) of the source instance or disk snapshot.
	Arn *string `locationName:"arn" type:"string"`

	// The date when the source instance or disk snapshot was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A list of objects describing a disk snapshot.
	DiskSnapshotInfo *DiskSnapshotInfo `locationName:"diskSnapshotInfo" type:"structure"`

	// The Amazon Resource Name (ARN) of the snapshot's source instance or disk.
	FromResourceArn *string `locationName:"fromResourceArn" type:"string"`

	// The name of the snapshot's source instance or disk.
	FromResourceName *string `locationName:"fromResourceName" type:"string"`

	// A list of objects describing an instance snapshot.
	InstanceSnapshotInfo *InstanceSnapshotInfo `locationName:"instanceSnapshotInfo" type:"structure"`

	// The name of the source instance or disk snapshot.
	Name *string `locationName:"name" type:"string"`

	// The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ExportSnapshotRecordSourceType"`
	// contains filtered or unexported fields
}

Describes the source of an export snapshot record.

func (ExportSnapshotRecordSourceInfo) GoString added in v1.99.0

GoString returns the string representation

func (*ExportSnapshotRecordSourceInfo) SetArn added in v1.99.0

SetArn sets the Arn field's value.

func (*ExportSnapshotRecordSourceInfo) SetCreatedAt added in v1.99.0

SetCreatedAt sets the CreatedAt field's value.

func (*ExportSnapshotRecordSourceInfo) SetDiskSnapshotInfo added in v1.99.0

SetDiskSnapshotInfo sets the DiskSnapshotInfo field's value.

func (*ExportSnapshotRecordSourceInfo) SetFromResourceArn added in v1.99.0

SetFromResourceArn sets the FromResourceArn field's value.

func (*ExportSnapshotRecordSourceInfo) SetFromResourceName added in v1.99.0

SetFromResourceName sets the FromResourceName field's value.

func (*ExportSnapshotRecordSourceInfo) SetInstanceSnapshotInfo added in v1.99.0

SetInstanceSnapshotInfo sets the InstanceSnapshotInfo field's value.

func (*ExportSnapshotRecordSourceInfo) SetName added in v1.99.0

SetName sets the Name field's value.

func (*ExportSnapshotRecordSourceInfo) SetResourceType added in v1.99.0

SetResourceType sets the ResourceType field's value.

func (ExportSnapshotRecordSourceInfo) String added in v1.99.0

String returns the string representation

type GetActiveNamesInput

type GetActiveNamesInput struct {

	// A token used for paginating results from your get active names request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetActiveNamesInput) GoString

func (s GetActiveNamesInput) GoString() string

GoString returns the string representation

func (*GetActiveNamesInput) SetPageToken

func (s *GetActiveNamesInput) SetPageToken(v string) *GetActiveNamesInput

SetPageToken sets the PageToken field's value.

func (GetActiveNamesInput) String

func (s GetActiveNamesInput) String() string

String returns the string representation

type GetActiveNamesOutput

type GetActiveNamesOutput struct {

	// The list of active names returned by the get active names request.
	ActiveNames []*string `locationName:"activeNames" type:"list"`

	// A token used for advancing to the next page of results from your get active
	// names request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetActiveNamesOutput) GoString

func (s GetActiveNamesOutput) GoString() string

GoString returns the string representation

func (*GetActiveNamesOutput) SetActiveNames

func (s *GetActiveNamesOutput) SetActiveNames(v []*string) *GetActiveNamesOutput

SetActiveNames sets the ActiveNames field's value.

func (*GetActiveNamesOutput) SetNextPageToken

func (s *GetActiveNamesOutput) SetNextPageToken(v string) *GetActiveNamesOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetActiveNamesOutput) String

func (s GetActiveNamesOutput) String() string

String returns the string representation

type GetBlueprintsInput

type GetBlueprintsInput struct {

	// A Boolean value indicating whether to include inactive results in your request.
	IncludeInactive *bool `locationName:"includeInactive" type:"boolean"`

	// A token used for advancing to the next page of results from your get blueprints
	// request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBlueprintsInput) GoString

func (s GetBlueprintsInput) GoString() string

GoString returns the string representation

func (*GetBlueprintsInput) SetIncludeInactive

func (s *GetBlueprintsInput) SetIncludeInactive(v bool) *GetBlueprintsInput

SetIncludeInactive sets the IncludeInactive field's value.

func (*GetBlueprintsInput) SetPageToken

func (s *GetBlueprintsInput) SetPageToken(v string) *GetBlueprintsInput

SetPageToken sets the PageToken field's value.

func (GetBlueprintsInput) String

func (s GetBlueprintsInput) String() string

String returns the string representation

type GetBlueprintsOutput

type GetBlueprintsOutput struct {

	// An array of key-value pairs that contains information about the available
	// blueprints.
	Blueprints []*Blueprint `locationName:"blueprints" type:"list"`

	// A token used for advancing to the next page of results from your get blueprints
	// request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBlueprintsOutput) GoString

func (s GetBlueprintsOutput) GoString() string

GoString returns the string representation

func (*GetBlueprintsOutput) SetBlueprints

func (s *GetBlueprintsOutput) SetBlueprints(v []*Blueprint) *GetBlueprintsOutput

SetBlueprints sets the Blueprints field's value.

func (*GetBlueprintsOutput) SetNextPageToken

func (s *GetBlueprintsOutput) SetNextPageToken(v string) *GetBlueprintsOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetBlueprintsOutput) String

func (s GetBlueprintsOutput) String() string

String returns the string representation

type GetBundlesInput

type GetBundlesInput struct {

	// A Boolean value that indicates whether to include inactive bundle results
	// in your request.
	IncludeInactive *bool `locationName:"includeInactive" type:"boolean"`

	// A token used for advancing to the next page of results from your get bundles
	// request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBundlesInput) GoString

func (s GetBundlesInput) GoString() string

GoString returns the string representation

func (*GetBundlesInput) SetIncludeInactive

func (s *GetBundlesInput) SetIncludeInactive(v bool) *GetBundlesInput

SetIncludeInactive sets the IncludeInactive field's value.

func (*GetBundlesInput) SetPageToken

func (s *GetBundlesInput) SetPageToken(v string) *GetBundlesInput

SetPageToken sets the PageToken field's value.

func (GetBundlesInput) String

func (s GetBundlesInput) String() string

String returns the string representation

type GetBundlesOutput

type GetBundlesOutput struct {

	// An array of key-value pairs that contains information about the available
	// bundles.
	Bundles []*Bundle `locationName:"bundles" type:"list"`

	// A token used for advancing to the next page of results from your get active
	// names request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBundlesOutput) GoString

func (s GetBundlesOutput) GoString() string

GoString returns the string representation

func (*GetBundlesOutput) SetBundles

func (s *GetBundlesOutput) SetBundles(v []*Bundle) *GetBundlesOutput

SetBundles sets the Bundles field's value.

func (*GetBundlesOutput) SetNextPageToken

func (s *GetBundlesOutput) SetNextPageToken(v string) *GetBundlesOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetBundlesOutput) String

func (s GetBundlesOutput) String() string

String returns the string representation

type GetCloudFormationStackRecordsInput added in v1.99.0

type GetCloudFormationStackRecordsInput struct {

	// A token used for advancing to a specific page of results for your get cloud
	// formation stack records request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetCloudFormationStackRecordsInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetCloudFormationStackRecordsInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (GetCloudFormationStackRecordsInput) String added in v1.99.0

String returns the string representation

type GetCloudFormationStackRecordsOutput added in v1.99.0

type GetCloudFormationStackRecordsOutput struct {

	// A list of objects describing the CloudFormation stack records.
	CloudFormationStackRecords []*CloudFormationStackRecord `locationName:"cloudFormationStackRecords" type:"list"`

	// A token used for advancing to the next page of results of your get relational
	// database bundles request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetCloudFormationStackRecordsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetCloudFormationStackRecordsOutput) SetCloudFormationStackRecords added in v1.99.0

SetCloudFormationStackRecords sets the CloudFormationStackRecords field's value.

func (*GetCloudFormationStackRecordsOutput) SetNextPageToken added in v1.99.0

SetNextPageToken sets the NextPageToken field's value.

func (GetCloudFormationStackRecordsOutput) String added in v1.99.0

String returns the string representation

type GetDiskInput added in v1.12.27

type GetDiskInput struct {

	// The name of the disk (e.g., my-disk).
	//
	// DiskName is a required field
	DiskName *string `locationName:"diskName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDiskInput) GoString added in v1.12.27

func (s GetDiskInput) GoString() string

GoString returns the string representation

func (*GetDiskInput) SetDiskName added in v1.12.27

func (s *GetDiskInput) SetDiskName(v string) *GetDiskInput

SetDiskName sets the DiskName field's value.

func (GetDiskInput) String added in v1.12.27

func (s GetDiskInput) String() string

String returns the string representation

func (*GetDiskInput) Validate added in v1.12.27

func (s *GetDiskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDiskOutput added in v1.12.27

type GetDiskOutput struct {

	// An object containing information about the disk.
	Disk *Disk `locationName:"disk" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDiskOutput) GoString added in v1.12.27

func (s GetDiskOutput) GoString() string

GoString returns the string representation

func (*GetDiskOutput) SetDisk added in v1.12.27

func (s *GetDiskOutput) SetDisk(v *Disk) *GetDiskOutput

SetDisk sets the Disk field's value.

func (GetDiskOutput) String added in v1.12.27

func (s GetDiskOutput) String() string

String returns the string representation

type GetDiskSnapshotInput added in v1.12.27

type GetDiskSnapshotInput struct {

	// The name of the disk snapshot (e.g., my-disk-snapshot).
	//
	// DiskSnapshotName is a required field
	DiskSnapshotName *string `locationName:"diskSnapshotName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDiskSnapshotInput) GoString added in v1.12.27

func (s GetDiskSnapshotInput) GoString() string

GoString returns the string representation

func (*GetDiskSnapshotInput) SetDiskSnapshotName added in v1.12.27

func (s *GetDiskSnapshotInput) SetDiskSnapshotName(v string) *GetDiskSnapshotInput

SetDiskSnapshotName sets the DiskSnapshotName field's value.

func (GetDiskSnapshotInput) String added in v1.12.27

func (s GetDiskSnapshotInput) String() string

String returns the string representation

func (*GetDiskSnapshotInput) Validate added in v1.12.27

func (s *GetDiskSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDiskSnapshotOutput added in v1.12.27

type GetDiskSnapshotOutput struct {

	// An object containing information about the disk snapshot.
	DiskSnapshot *DiskSnapshot `locationName:"diskSnapshot" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDiskSnapshotOutput) GoString added in v1.12.27

func (s GetDiskSnapshotOutput) GoString() string

GoString returns the string representation

func (*GetDiskSnapshotOutput) SetDiskSnapshot added in v1.12.27

SetDiskSnapshot sets the DiskSnapshot field's value.

func (GetDiskSnapshotOutput) String added in v1.12.27

func (s GetDiskSnapshotOutput) String() string

String returns the string representation

type GetDiskSnapshotsInput added in v1.12.27

type GetDiskSnapshotsInput struct {

	// A token used for advancing to the next page of results from your GetDiskSnapshots
	// request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDiskSnapshotsInput) GoString added in v1.12.27

func (s GetDiskSnapshotsInput) GoString() string

GoString returns the string representation

func (*GetDiskSnapshotsInput) SetPageToken added in v1.12.27

SetPageToken sets the PageToken field's value.

func (GetDiskSnapshotsInput) String added in v1.12.27

func (s GetDiskSnapshotsInput) String() string

String returns the string representation

type GetDiskSnapshotsOutput added in v1.12.27

type GetDiskSnapshotsOutput struct {

	// An array of objects containing information about all block storage disk snapshots.
	DiskSnapshots []*DiskSnapshot `locationName:"diskSnapshots" type:"list"`

	// A token used for advancing to the next page of results from your GetDiskSnapshots
	// request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDiskSnapshotsOutput) GoString added in v1.12.27

func (s GetDiskSnapshotsOutput) GoString() string

GoString returns the string representation

func (*GetDiskSnapshotsOutput) SetDiskSnapshots added in v1.12.27

func (s *GetDiskSnapshotsOutput) SetDiskSnapshots(v []*DiskSnapshot) *GetDiskSnapshotsOutput

SetDiskSnapshots sets the DiskSnapshots field's value.

func (*GetDiskSnapshotsOutput) SetNextPageToken added in v1.12.27

func (s *GetDiskSnapshotsOutput) SetNextPageToken(v string) *GetDiskSnapshotsOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetDiskSnapshotsOutput) String added in v1.12.27

func (s GetDiskSnapshotsOutput) String() string

String returns the string representation

type GetDisksInput added in v1.12.27

type GetDisksInput struct {

	// A token used for advancing to the next page of results from your GetDisks
	// request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDisksInput) GoString added in v1.12.27

func (s GetDisksInput) GoString() string

GoString returns the string representation

func (*GetDisksInput) SetPageToken added in v1.12.27

func (s *GetDisksInput) SetPageToken(v string) *GetDisksInput

SetPageToken sets the PageToken field's value.

func (GetDisksInput) String added in v1.12.27

func (s GetDisksInput) String() string

String returns the string representation

type GetDisksOutput added in v1.12.27

type GetDisksOutput struct {

	// An array of objects containing information about all block storage disks.
	Disks []*Disk `locationName:"disks" type:"list"`

	// A token used for advancing to the next page of results from your GetDisks
	// request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDisksOutput) GoString added in v1.12.27

func (s GetDisksOutput) GoString() string

GoString returns the string representation

func (*GetDisksOutput) SetDisks added in v1.12.27

func (s *GetDisksOutput) SetDisks(v []*Disk) *GetDisksOutput

SetDisks sets the Disks field's value.

func (*GetDisksOutput) SetNextPageToken added in v1.12.27

func (s *GetDisksOutput) SetNextPageToken(v string) *GetDisksOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetDisksOutput) String added in v1.12.27

func (s GetDisksOutput) String() string

String returns the string representation

type GetDomainInput

type GetDomainInput struct {

	// The domain name for which your want to return information about.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDomainInput) GoString

func (s GetDomainInput) GoString() string

GoString returns the string representation

func (*GetDomainInput) SetDomainName

func (s *GetDomainInput) SetDomainName(v string) *GetDomainInput

SetDomainName sets the DomainName field's value.

func (GetDomainInput) String

func (s GetDomainInput) String() string

String returns the string representation

func (*GetDomainInput) Validate

func (s *GetDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDomainOutput

type GetDomainOutput struct {

	// An array of key-value pairs containing information about your get domain
	// request.
	Domain *Domain `locationName:"domain" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDomainOutput) GoString

func (s GetDomainOutput) GoString() string

GoString returns the string representation

func (*GetDomainOutput) SetDomain

func (s *GetDomainOutput) SetDomain(v *Domain) *GetDomainOutput

SetDomain sets the Domain field's value.

func (GetDomainOutput) String

func (s GetDomainOutput) String() string

String returns the string representation

type GetDomainsInput

type GetDomainsInput struct {

	// A token used for advancing to the next page of results from your get domains
	// request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDomainsInput) GoString

func (s GetDomainsInput) GoString() string

GoString returns the string representation

func (*GetDomainsInput) SetPageToken

func (s *GetDomainsInput) SetPageToken(v string) *GetDomainsInput

SetPageToken sets the PageToken field's value.

func (GetDomainsInput) String

func (s GetDomainsInput) String() string

String returns the string representation

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 []*Domain `locationName:"domains" type:"list"`

	// A token used for advancing to the next page of results from your get active
	// names request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDomainsOutput) GoString

func (s GetDomainsOutput) GoString() string

GoString returns the string representation

func (*GetDomainsOutput) SetDomains

func (s *GetDomainsOutput) SetDomains(v []*Domain) *GetDomainsOutput

SetDomains sets the Domains field's value.

func (*GetDomainsOutput) SetNextPageToken

func (s *GetDomainsOutput) SetNextPageToken(v string) *GetDomainsOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetDomainsOutput) String

func (s GetDomainsOutput) String() string

String returns the string representation

type GetExportSnapshotRecordsInput added in v1.99.0

type GetExportSnapshotRecordsInput struct {

	// A token used for advancing to a specific page of results for your get export
	// snapshot records request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetExportSnapshotRecordsInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetExportSnapshotRecordsInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (GetExportSnapshotRecordsInput) String added in v1.99.0

String returns the string representation

type GetExportSnapshotRecordsOutput added in v1.99.0

type GetExportSnapshotRecordsOutput struct {

	// A list of objects describing the export snapshot records.
	ExportSnapshotRecords []*ExportSnapshotRecord `locationName:"exportSnapshotRecords" type:"list"`

	// A token used for advancing to the next page of results of your get relational
	// database bundles request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetExportSnapshotRecordsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetExportSnapshotRecordsOutput) SetExportSnapshotRecords added in v1.99.0

SetExportSnapshotRecords sets the ExportSnapshotRecords field's value.

func (*GetExportSnapshotRecordsOutput) SetNextPageToken added in v1.99.0

SetNextPageToken sets the NextPageToken field's value.

func (GetExportSnapshotRecordsOutput) String added in v1.99.0

String returns the string representation

type GetInstanceAccessDetailsInput

type GetInstanceAccessDetailsInput struct {

	// The name of the instance to access.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`

	// The protocol to use to connect to your instance. Defaults to ssh.
	Protocol *string `locationName:"protocol" type:"string" enum:"InstanceAccessProtocol"`
	// contains filtered or unexported fields
}

func (GetInstanceAccessDetailsInput) GoString

GoString returns the string representation

func (*GetInstanceAccessDetailsInput) SetInstanceName

SetInstanceName sets the InstanceName field's value.

func (*GetInstanceAccessDetailsInput) SetProtocol

SetProtocol sets the Protocol field's value.

func (GetInstanceAccessDetailsInput) String

String returns the string representation

func (*GetInstanceAccessDetailsInput) Validate

func (s *GetInstanceAccessDetailsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceAccessDetailsOutput

type GetInstanceAccessDetailsOutput struct {

	// An array of key-value pairs containing information about a get instance access
	// request.
	AccessDetails *InstanceAccessDetails `locationName:"accessDetails" type:"structure"`
	// contains filtered or unexported fields
}

func (GetInstanceAccessDetailsOutput) GoString

GoString returns the string representation

func (*GetInstanceAccessDetailsOutput) SetAccessDetails

SetAccessDetails sets the AccessDetails field's value.

func (GetInstanceAccessDetailsOutput) String

String returns the string representation

type GetInstanceInput

type GetInstanceInput struct {

	// The name of the instance.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInstanceInput) GoString

func (s GetInstanceInput) GoString() string

GoString returns the string representation

func (*GetInstanceInput) SetInstanceName

func (s *GetInstanceInput) SetInstanceName(v string) *GetInstanceInput

SetInstanceName sets the InstanceName field's value.

func (GetInstanceInput) String

func (s GetInstanceInput) String() string

String returns the string representation

func (*GetInstanceInput) Validate

func (s *GetInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceMetricDataInput

type GetInstanceMetricDataInput struct {

	// The end time of the time period.
	//
	// EndTime is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The name of the instance for which you want to get metrics data.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`

	// The metric name to get data about.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"InstanceMetricName"`

	// The granularity, in seconds, of the returned data points.
	//
	// Period is a required field
	Period *int64 `locationName:"period" min:"60" type:"integer" required:"true"`

	// The start time of the time period.
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

	// The instance statistics.
	//
	// Statistics is a required field
	Statistics []*string `locationName:"statistics" type:"list" required:"true"`

	// The unit. The list of valid values is below.
	//
	// Unit is a required field
	Unit *string `locationName:"unit" type:"string" required:"true" enum:"MetricUnit"`
	// contains filtered or unexported fields
}

func (GetInstanceMetricDataInput) GoString

func (s GetInstanceMetricDataInput) GoString() string

GoString returns the string representation

func (*GetInstanceMetricDataInput) SetEndTime

SetEndTime sets the EndTime field's value.

func (*GetInstanceMetricDataInput) SetInstanceName

SetInstanceName sets the InstanceName field's value.

func (*GetInstanceMetricDataInput) SetMetricName

SetMetricName sets the MetricName field's value.

func (*GetInstanceMetricDataInput) SetPeriod

SetPeriod sets the Period field's value.

func (*GetInstanceMetricDataInput) SetStartTime

SetStartTime sets the StartTime field's value.

func (*GetInstanceMetricDataInput) SetStatistics

SetStatistics sets the Statistics field's value.

func (*GetInstanceMetricDataInput) SetUnit

SetUnit sets the Unit field's value.

func (GetInstanceMetricDataInput) String

String returns the string representation

func (*GetInstanceMetricDataInput) Validate

func (s *GetInstanceMetricDataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceMetricDataOutput

type GetInstanceMetricDataOutput struct {

	// An array of key-value pairs containing information about the results of your
	// get instance metric data request.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The metric name to return data for.
	MetricName *string `locationName:"metricName" type:"string" enum:"InstanceMetricName"`
	// contains filtered or unexported fields
}

func (GetInstanceMetricDataOutput) GoString

func (s GetInstanceMetricDataOutput) GoString() string

GoString returns the string representation

func (*GetInstanceMetricDataOutput) SetMetricData

SetMetricData sets the MetricData field's value.

func (*GetInstanceMetricDataOutput) SetMetricName

SetMetricName sets the MetricName field's value.

func (GetInstanceMetricDataOutput) String

String returns the string representation

type GetInstanceOutput

type GetInstanceOutput struct {

	// An array of key-value pairs containing information about the specified instance.
	Instance *Instance `locationName:"instance" type:"structure"`
	// contains filtered or unexported fields
}

func (GetInstanceOutput) GoString

func (s GetInstanceOutput) GoString() string

GoString returns the string representation

func (*GetInstanceOutput) SetInstance

func (s *GetInstanceOutput) SetInstance(v *Instance) *GetInstanceOutput

SetInstance sets the Instance field's value.

func (GetInstanceOutput) String

func (s GetInstanceOutput) String() string

String returns the string representation

type GetInstancePortStatesInput

type GetInstancePortStatesInput struct {

	// The name of the instance.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInstancePortStatesInput) GoString

func (s GetInstancePortStatesInput) GoString() string

GoString returns the string representation

func (*GetInstancePortStatesInput) SetInstanceName

SetInstanceName sets the InstanceName field's value.

func (GetInstancePortStatesInput) String

String returns the string representation

func (*GetInstancePortStatesInput) Validate

func (s *GetInstancePortStatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstancePortStatesOutput

type GetInstancePortStatesOutput struct {

	// Information about the port states resulting from your request.
	PortStates []*InstancePortState `locationName:"portStates" type:"list"`
	// contains filtered or unexported fields
}

func (GetInstancePortStatesOutput) GoString

func (s GetInstancePortStatesOutput) GoString() string

GoString returns the string representation

func (*GetInstancePortStatesOutput) SetPortStates

SetPortStates sets the PortStates field's value.

func (GetInstancePortStatesOutput) String

String returns the string representation

type GetInstanceSnapshotInput

type GetInstanceSnapshotInput struct {

	// The name of the snapshot for which you are requesting information.
	//
	// InstanceSnapshotName is a required field
	InstanceSnapshotName *string `locationName:"instanceSnapshotName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInstanceSnapshotInput) GoString

func (s GetInstanceSnapshotInput) GoString() string

GoString returns the string representation

func (*GetInstanceSnapshotInput) SetInstanceSnapshotName

func (s *GetInstanceSnapshotInput) SetInstanceSnapshotName(v string) *GetInstanceSnapshotInput

SetInstanceSnapshotName sets the InstanceSnapshotName field's value.

func (GetInstanceSnapshotInput) String

func (s GetInstanceSnapshotInput) String() string

String returns the string representation

func (*GetInstanceSnapshotInput) Validate

func (s *GetInstanceSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceSnapshotOutput

type GetInstanceSnapshotOutput struct {

	// An array of key-value pairs containing information about the results of your
	// get instance snapshot request.
	InstanceSnapshot *InstanceSnapshot `locationName:"instanceSnapshot" type:"structure"`
	// contains filtered or unexported fields
}

func (GetInstanceSnapshotOutput) GoString

func (s GetInstanceSnapshotOutput) GoString() string

GoString returns the string representation

func (*GetInstanceSnapshotOutput) SetInstanceSnapshot

SetInstanceSnapshot sets the InstanceSnapshot field's value.

func (GetInstanceSnapshotOutput) String

func (s GetInstanceSnapshotOutput) String() string

String returns the string representation

type GetInstanceSnapshotsInput

type GetInstanceSnapshotsInput struct {

	// A token used for advancing to the next page of results from your get instance
	// snapshots request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetInstanceSnapshotsInput) GoString

func (s GetInstanceSnapshotsInput) GoString() string

GoString returns the string representation

func (*GetInstanceSnapshotsInput) SetPageToken

SetPageToken sets the PageToken field's value.

func (GetInstanceSnapshotsInput) String

func (s GetInstanceSnapshotsInput) String() string

String returns the string representation

type GetInstanceSnapshotsOutput

type GetInstanceSnapshotsOutput struct {

	// An array of key-value pairs containing information about the results of your
	// get instance snapshots request.
	InstanceSnapshots []*InstanceSnapshot `locationName:"instanceSnapshots" type:"list"`

	// A token used for advancing to the next page of results from your get instance
	// snapshots request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetInstanceSnapshotsOutput) GoString

func (s GetInstanceSnapshotsOutput) GoString() string

GoString returns the string representation

func (*GetInstanceSnapshotsOutput) SetInstanceSnapshots

SetInstanceSnapshots sets the InstanceSnapshots field's value.

func (*GetInstanceSnapshotsOutput) SetNextPageToken

SetNextPageToken sets the NextPageToken field's value.

func (GetInstanceSnapshotsOutput) String

String returns the string representation

type GetInstanceStateInput

type GetInstanceStateInput struct {

	// The name of the instance to get state information about.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInstanceStateInput) GoString

func (s GetInstanceStateInput) GoString() string

GoString returns the string representation

func (*GetInstanceStateInput) SetInstanceName

func (s *GetInstanceStateInput) SetInstanceName(v string) *GetInstanceStateInput

SetInstanceName sets the InstanceName field's value.

func (GetInstanceStateInput) String

func (s GetInstanceStateInput) String() string

String returns the string representation

func (*GetInstanceStateInput) Validate

func (s *GetInstanceStateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceStateOutput

type GetInstanceStateOutput struct {

	// The state of the instance.
	State *InstanceState `locationName:"state" type:"structure"`
	// contains filtered or unexported fields
}

func (GetInstanceStateOutput) GoString

func (s GetInstanceStateOutput) GoString() string

GoString returns the string representation

func (*GetInstanceStateOutput) SetState

SetState sets the State field's value.

func (GetInstanceStateOutput) String

func (s GetInstanceStateOutput) String() string

String returns the string representation

type GetInstancesInput

type GetInstancesInput struct {

	// A token used for advancing to the next page of results from your get instances
	// request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetInstancesInput) GoString

func (s GetInstancesInput) GoString() string

GoString returns the string representation

func (*GetInstancesInput) SetPageToken

func (s *GetInstancesInput) SetPageToken(v string) *GetInstancesInput

SetPageToken sets the PageToken field's value.

func (GetInstancesInput) String

func (s GetInstancesInput) String() string

String returns the string representation

type GetInstancesOutput

type GetInstancesOutput struct {

	// An array of key-value pairs containing information about your instances.
	Instances []*Instance `locationName:"instances" type:"list"`

	// A token used for advancing to the next page of results from your get instances
	// request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetInstancesOutput) GoString

func (s GetInstancesOutput) GoString() string

GoString returns the string representation

func (*GetInstancesOutput) SetInstances

func (s *GetInstancesOutput) SetInstances(v []*Instance) *GetInstancesOutput

SetInstances sets the Instances field's value.

func (*GetInstancesOutput) SetNextPageToken

func (s *GetInstancesOutput) SetNextPageToken(v string) *GetInstancesOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetInstancesOutput) String

func (s GetInstancesOutput) String() string

String returns the string representation

type GetKeyPairInput

type GetKeyPairInput struct {

	// The name of the key pair for which you are requesting information.
	//
	// KeyPairName is a required field
	KeyPairName *string `locationName:"keyPairName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetKeyPairInput) GoString

func (s GetKeyPairInput) GoString() string

GoString returns the string representation

func (*GetKeyPairInput) SetKeyPairName

func (s *GetKeyPairInput) SetKeyPairName(v string) *GetKeyPairInput

SetKeyPairName sets the KeyPairName field's value.

func (GetKeyPairInput) String

func (s GetKeyPairInput) String() string

String returns the string representation

func (*GetKeyPairInput) Validate

func (s *GetKeyPairInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKeyPairOutput

type GetKeyPairOutput struct {

	// An array of key-value pairs containing information about the key pair.
	KeyPair *KeyPair `locationName:"keyPair" type:"structure"`
	// contains filtered or unexported fields
}

func (GetKeyPairOutput) GoString

func (s GetKeyPairOutput) GoString() string

GoString returns the string representation

func (*GetKeyPairOutput) SetKeyPair

func (s *GetKeyPairOutput) SetKeyPair(v *KeyPair) *GetKeyPairOutput

SetKeyPair sets the KeyPair field's value.

func (GetKeyPairOutput) String

func (s GetKeyPairOutput) String() string

String returns the string representation

type GetKeyPairsInput

type GetKeyPairsInput struct {

	// A token used for advancing to the next page of results from your get key
	// pairs request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetKeyPairsInput) GoString

func (s GetKeyPairsInput) GoString() string

GoString returns the string representation

func (*GetKeyPairsInput) SetPageToken

func (s *GetKeyPairsInput) SetPageToken(v string) *GetKeyPairsInput

SetPageToken sets the PageToken field's value.

func (GetKeyPairsInput) String

func (s GetKeyPairsInput) String() string

String returns the string representation

type GetKeyPairsOutput

type GetKeyPairsOutput struct {

	// An array of key-value pairs containing information about the key pairs.
	KeyPairs []*KeyPair `locationName:"keyPairs" type:"list"`

	// A token used for advancing to the next page of results from your get key
	// pairs request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetKeyPairsOutput) GoString

func (s GetKeyPairsOutput) GoString() string

GoString returns the string representation

func (*GetKeyPairsOutput) SetKeyPairs

func (s *GetKeyPairsOutput) SetKeyPairs(v []*KeyPair) *GetKeyPairsOutput

SetKeyPairs sets the KeyPairs field's value.

func (*GetKeyPairsOutput) SetNextPageToken

func (s *GetKeyPairsOutput) SetNextPageToken(v string) *GetKeyPairsOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetKeyPairsOutput) String

func (s GetKeyPairsOutput) String() string

String returns the string representation

type GetLoadBalancerInput added in v1.12.37

type GetLoadBalancerInput struct {

	// The name of the load balancer.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerInput) GoString added in v1.12.37

func (s GetLoadBalancerInput) GoString() string

GoString returns the string representation

func (*GetLoadBalancerInput) SetLoadBalancerName added in v1.12.37

func (s *GetLoadBalancerInput) SetLoadBalancerName(v string) *GetLoadBalancerInput

SetLoadBalancerName sets the LoadBalancerName field's value.

func (GetLoadBalancerInput) String added in v1.12.37

func (s GetLoadBalancerInput) String() string

String returns the string representation

func (*GetLoadBalancerInput) Validate added in v1.12.37

func (s *GetLoadBalancerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLoadBalancerMetricDataInput added in v1.12.37

type GetLoadBalancerMetricDataInput struct {

	// The end time of the period.
	//
	// EndTime is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The name of the load balancer.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`

	// The metric about which you want to return information. Valid values are listed
	// below, along with the most useful statistics to include in your request.
	//
	//    * ClientTLSNegotiationErrorCount - The number of TLS connections initiated
	//    by the client that did not establish a session with the load balancer.
	//    Possible causes include a mismatch of ciphers or protocols. Statistics:
	//    The most useful statistic is Sum.
	//
	//    * HealthyHostCount - The number of target instances that are considered
	//    healthy. Statistics: The most useful statistic are Average, Minimum, and
	//    Maximum.
	//
	//    * UnhealthyHostCount - The number of target instances that are considered
	//    unhealthy. Statistics: The most useful statistic are Average, Minimum,
	//    and Maximum.
	//
	//    * HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that
	//    originate from the load balancer. Client errors are generated when requests
	//    are malformed or incomplete. These requests have not been received by
	//    the target instance. This count does not include any response codes generated
	//    by the target instances. Statistics: The most useful statistic is Sum.
	//    Note that Minimum, Maximum, and Average all return 1.
	//
	//    * HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that
	//    originate from the load balancer. This count does not include any response
	//    codes generated by the target instances. Statistics: The most useful statistic
	//    is Sum. Note that Minimum, Maximum, and Average all return 1. Note that
	//    Minimum, Maximum, and Average all return 1.
	//
	//    * HTTPCode_Instance_2XX_Count - The number of HTTP 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.
	//
	//    * HTTPCode_Instance_3XX_Count - The number of HTTP 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.
	//
	//    * HTTPCode_Instance_4XX_Count - The number of HTTP 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.
	//
	//    * HTTPCode_Instance_5XX_Count - The number of HTTP 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.
	//
	//    * 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.
	//
	//    * 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.
	//
	//    * 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.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"LoadBalancerMetricName"`

	// The granularity, in seconds, of the returned data points.
	//
	// Period is a required field
	Period *int64 `locationName:"period" min:"60" type:"integer" required:"true"`

	// The start time of the period.
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

	// An array of statistics that you want to request metrics for. Valid values
	// are listed below.
	//
	//    * SampleCount - The count (number) of data points used for the statistical
	//    calculation.
	//
	//    * Average - The value of Sum / SampleCount during the specified period.
	//    By comparing this statistic with the Minimum and Maximum, you can determine
	//    the full scope of a metric and how close the average use is to the Minimum
	//    and Maximum. This comparison helps you to know when to increase or decrease
	//    your resources as needed.
	//
	//    * Sum - All values submitted for the matching metric added together. This
	//    statistic can be useful for determining the total volume of a metric.
	//
	//    * Minimum - The lowest value observed during the specified period. You
	//    can use this value to determine low volumes of activity for your application.
	//
	//    * Maximum - The highest value observed during the specified period. You
	//    can use this value to determine high volumes of activity for your application.
	//
	// Statistics is a required field
	Statistics []*string `locationName:"statistics" type:"list" required:"true"`

	// The unit for the time period request. Valid values are listed below.
	//
	// Unit is a required field
	Unit *string `locationName:"unit" type:"string" required:"true" enum:"MetricUnit"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerMetricDataInput) GoString added in v1.12.37

GoString returns the string representation

func (*GetLoadBalancerMetricDataInput) SetEndTime added in v1.12.37

SetEndTime sets the EndTime field's value.

func (*GetLoadBalancerMetricDataInput) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*GetLoadBalancerMetricDataInput) SetMetricName added in v1.12.37

SetMetricName sets the MetricName field's value.

func (*GetLoadBalancerMetricDataInput) SetPeriod added in v1.12.37

SetPeriod sets the Period field's value.

func (*GetLoadBalancerMetricDataInput) SetStartTime added in v1.12.37

SetStartTime sets the StartTime field's value.

func (*GetLoadBalancerMetricDataInput) SetStatistics added in v1.12.37

SetStatistics sets the Statistics field's value.

func (*GetLoadBalancerMetricDataInput) SetUnit added in v1.12.37

SetUnit sets the Unit field's value.

func (GetLoadBalancerMetricDataInput) String added in v1.12.37

String returns the string representation

func (*GetLoadBalancerMetricDataInput) Validate added in v1.12.37

func (s *GetLoadBalancerMetricDataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLoadBalancerMetricDataOutput added in v1.12.37

type GetLoadBalancerMetricDataOutput struct {

	// An array of metric datapoint objects.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The metric about which you are receiving information. Valid values are listed
	// below, along with the most useful statistics to include in your request.
	//
	//    * ClientTLSNegotiationErrorCount - The number of TLS connections initiated
	//    by the client that did not establish a session with the load balancer.
	//    Possible causes include a mismatch of ciphers or protocols. Statistics:
	//    The most useful statistic is Sum.
	//
	//    * HealthyHostCount - The number of target instances that are considered
	//    healthy. Statistics: The most useful statistic are Average, Minimum, and
	//    Maximum.
	//
	//    * UnhealthyHostCount - The number of target instances that are considered
	//    unhealthy. Statistics: The most useful statistic are Average, Minimum,
	//    and Maximum.
	//
	//    * HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that
	//    originate from the load balancer. Client errors are generated when requests
	//    are malformed or incomplete. These requests have not been received by
	//    the target instance. This count does not include any response codes generated
	//    by the target instances. Statistics: The most useful statistic is Sum.
	//    Note that Minimum, Maximum, and Average all return 1.
	//
	//    * HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that
	//    originate from the load balancer. This count does not include any response
	//    codes generated by the target instances. Statistics: The most useful statistic
	//    is Sum. Note that Minimum, Maximum, and Average all return 1. Note that
	//    Minimum, Maximum, and Average all return 1.
	//
	//    * HTTPCode_Instance_2XX_Count - The number of HTTP 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.
	//
	//    * HTTPCode_Instance_3XX_Count - The number of HTTP 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.
	//
	//    * HTTPCode_Instance_4XX_Count - The number of HTTP 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.
	//
	//    * HTTPCode_Instance_5XX_Count - The number of HTTP 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.
	//
	//    * 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.
	//
	//    * 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.
	//
	//    * 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.
	MetricName *string `locationName:"metricName" type:"string" enum:"LoadBalancerMetricName"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerMetricDataOutput) GoString added in v1.12.37

GoString returns the string representation

func (*GetLoadBalancerMetricDataOutput) SetMetricData added in v1.12.37

SetMetricData sets the MetricData field's value.

func (*GetLoadBalancerMetricDataOutput) SetMetricName added in v1.12.37

SetMetricName sets the MetricName field's value.

func (GetLoadBalancerMetricDataOutput) String added in v1.12.37

String returns the string representation

type GetLoadBalancerOutput added in v1.12.37

type GetLoadBalancerOutput struct {

	// An object containing information about your load balancer.
	LoadBalancer *LoadBalancer `locationName:"loadBalancer" type:"structure"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerOutput) GoString added in v1.12.37

func (s GetLoadBalancerOutput) GoString() string

GoString returns the string representation

func (*GetLoadBalancerOutput) SetLoadBalancer added in v1.12.37

SetLoadBalancer sets the LoadBalancer field's value.

func (GetLoadBalancerOutput) String added in v1.12.37

func (s GetLoadBalancerOutput) String() string

String returns the string representation

type GetLoadBalancerTlsCertificatesInput added in v1.12.37

type GetLoadBalancerTlsCertificatesInput struct {

	// The name of the load balancer you associated with your SSL/TLS certificate.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerTlsCertificatesInput) GoString added in v1.12.37

GoString returns the string representation

func (*GetLoadBalancerTlsCertificatesInput) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (GetLoadBalancerTlsCertificatesInput) String added in v1.12.37

String returns the string representation

func (*GetLoadBalancerTlsCertificatesInput) Validate added in v1.12.37

Validate inspects the fields of the type to determine if they are valid.

type GetLoadBalancerTlsCertificatesOutput added in v1.12.37

type GetLoadBalancerTlsCertificatesOutput struct {

	// An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.
	TlsCertificates []*LoadBalancerTlsCertificate `locationName:"tlsCertificates" type:"list"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerTlsCertificatesOutput) GoString added in v1.12.37

GoString returns the string representation

func (*GetLoadBalancerTlsCertificatesOutput) SetTlsCertificates added in v1.12.37

SetTlsCertificates sets the TlsCertificates field's value.

func (GetLoadBalancerTlsCertificatesOutput) String added in v1.12.37

String returns the string representation

type GetLoadBalancersInput added in v1.12.37

type GetLoadBalancersInput struct {

	// A token used for paginating the results from your GetLoadBalancers request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetLoadBalancersInput) GoString added in v1.12.37

func (s GetLoadBalancersInput) GoString() string

GoString returns the string representation

func (*GetLoadBalancersInput) SetPageToken added in v1.12.37

SetPageToken sets the PageToken field's value.

func (GetLoadBalancersInput) String added in v1.12.37

func (s GetLoadBalancersInput) String() string

String returns the string representation

type GetLoadBalancersOutput added in v1.12.37

type GetLoadBalancersOutput struct {

	// An array of LoadBalancer objects describing your load balancers.
	LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"`

	// A token used for advancing to the next page of results from your GetLoadBalancers
	// request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetLoadBalancersOutput) GoString added in v1.12.37

func (s GetLoadBalancersOutput) GoString() string

GoString returns the string representation

func (*GetLoadBalancersOutput) SetLoadBalancers added in v1.12.37

func (s *GetLoadBalancersOutput) SetLoadBalancers(v []*LoadBalancer) *GetLoadBalancersOutput

SetLoadBalancers sets the LoadBalancers field's value.

func (*GetLoadBalancersOutput) SetNextPageToken added in v1.12.37

func (s *GetLoadBalancersOutput) SetNextPageToken(v string) *GetLoadBalancersOutput

SetNextPageToken sets the NextPageToken field's value.

func (GetLoadBalancersOutput) String added in v1.12.37

func (s GetLoadBalancersOutput) String() string

String returns the string representation

type GetOperationInput

type GetOperationInput struct {

	// A GUID used to identify the operation.
	//
	// OperationId is a required field
	OperationId *string `locationName:"operationId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetOperationInput) GoString

func (s GetOperationInput) GoString() string

GoString returns the string representation

func (*GetOperationInput) SetOperationId

func (s *GetOperationInput) SetOperationId(v string) *GetOperationInput

SetOperationId sets the OperationId field's value.

func (GetOperationInput) String

func (s GetOperationInput) String() string

String returns the string representation

func (*GetOperationInput) Validate

func (s *GetOperationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOperationOutput

type GetOperationOutput struct {

	// An array of key-value pairs containing information about the results of your
	// get operation request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (GetOperationOutput) GoString

func (s GetOperationOutput) GoString() string

GoString returns the string representation

func (*GetOperationOutput) SetOperation

func (s *GetOperationOutput) SetOperation(v *Operation) *GetOperationOutput

SetOperation sets the Operation field's value.

func (GetOperationOutput) String

func (s GetOperationOutput) String() string

String returns the string representation

type GetOperationsForResourceInput

type GetOperationsForResourceInput struct {

	// A token used for advancing to the next page of results from your get operations
	// for resource request.
	PageToken *string `locationName:"pageToken" type:"string"`

	// The name of the resource for which you are requesting information.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetOperationsForResourceInput) GoString

GoString returns the string representation

func (*GetOperationsForResourceInput) SetPageToken

SetPageToken sets the PageToken field's value.

func (*GetOperationsForResourceInput) SetResourceName

SetResourceName sets the ResourceName field's value.

func (GetOperationsForResourceInput) String

String returns the string representation

func (*GetOperationsForResourceInput) Validate

func (s *GetOperationsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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: NextPageCount has been deprecated
	NextPageCount *string `locationName:"nextPageCount" deprecated:"true" type:"string"`

	// An identifier that was returned from the previous call to this operation,
	// which can be used to return the next set of items in the list.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// An array of key-value pairs containing information about the results of your
	// get operations for resource request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (GetOperationsForResourceOutput) GoString

GoString returns the string representation

func (*GetOperationsForResourceOutput) SetNextPageCount

SetNextPageCount sets the NextPageCount field's value.

func (*GetOperationsForResourceOutput) SetNextPageToken added in v1.10.2

SetNextPageToken sets the NextPageToken field's value.

func (*GetOperationsForResourceOutput) SetOperations

SetOperations sets the Operations field's value.

func (GetOperationsForResourceOutput) String

String returns the string representation

type GetOperationsInput

type GetOperationsInput struct {

	// A token used for advancing to the next page of results from your get operations
	// request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetOperationsInput) GoString

func (s GetOperationsInput) GoString() string

GoString returns the string representation

func (*GetOperationsInput) SetPageToken

func (s *GetOperationsInput) SetPageToken(v string) *GetOperationsInput

SetPageToken sets the PageToken field's value.

func (GetOperationsInput) String

func (s GetOperationsInput) String() string

String returns the string representation

type GetOperationsOutput

type GetOperationsOutput struct {

	// A token used for advancing to the next page of results from your get operations
	// request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// An array of key-value pairs containing information about the results of your
	// get operations request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (GetOperationsOutput) GoString

func (s GetOperationsOutput) GoString() string

GoString returns the string representation

func (*GetOperationsOutput) SetNextPageToken

func (s *GetOperationsOutput) SetNextPageToken(v string) *GetOperationsOutput

SetNextPageToken sets the NextPageToken field's value.

func (*GetOperationsOutput) SetOperations

func (s *GetOperationsOutput) SetOperations(v []*Operation) *GetOperationsOutput

SetOperations sets the Operations field's value.

func (GetOperationsOutput) String

func (s GetOperationsOutput) String() string

String returns the string representation

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 `locationName:"includeAvailabilityZones" type:"boolean"`

	// >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 `locationName:"includeRelationalDatabaseAvailabilityZones" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetRegionsInput) GoString

func (s GetRegionsInput) GoString() string

GoString returns the string representation

func (*GetRegionsInput) SetIncludeAvailabilityZones

func (s *GetRegionsInput) SetIncludeAvailabilityZones(v bool) *GetRegionsInput

SetIncludeAvailabilityZones sets the IncludeAvailabilityZones field's value.

func (*GetRegionsInput) SetIncludeRelationalDatabaseAvailabilityZones added in v1.99.0

func (s *GetRegionsInput) SetIncludeRelationalDatabaseAvailabilityZones(v bool) *GetRegionsInput

SetIncludeRelationalDatabaseAvailabilityZones sets the IncludeRelationalDatabaseAvailabilityZones field's value.

func (GetRegionsInput) String

func (s GetRegionsInput) String() string

String returns the string representation

type GetRegionsOutput

type GetRegionsOutput struct {

	// An array of key-value pairs containing information about your get regions
	// request.
	Regions []*Region `locationName:"regions" type:"list"`
	// contains filtered or unexported fields
}

func (GetRegionsOutput) GoString

func (s GetRegionsOutput) GoString() string

GoString returns the string representation

func (*GetRegionsOutput) SetRegions

func (s *GetRegionsOutput) SetRegions(v []*Region) *GetRegionsOutput

SetRegions sets the Regions field's value.

func (GetRegionsOutput) String

func (s GetRegionsOutput) String() string

String returns the string representation

type GetRelationalDatabaseBlueprintsInput added in v1.99.0

type GetRelationalDatabaseBlueprintsInput struct {

	// A token used for advancing to a specific page of results for your get relational
	// database blueprints request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseBlueprintsInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseBlueprintsInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (GetRelationalDatabaseBlueprintsInput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseBlueprintsOutput added in v1.99.0

type GetRelationalDatabaseBlueprintsOutput struct {

	// An object describing the result of your get relational database blueprints
	// request.
	Blueprints []*RelationalDatabaseBlueprint `locationName:"blueprints" type:"list"`

	// A token used for advancing to the next page of results of your get relational
	// database blueprints request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseBlueprintsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseBlueprintsOutput) SetBlueprints added in v1.99.0

SetBlueprints sets the Blueprints field's value.

func (*GetRelationalDatabaseBlueprintsOutput) SetNextPageToken added in v1.99.0

SetNextPageToken sets the NextPageToken field's value.

func (GetRelationalDatabaseBlueprintsOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseBundlesInput added in v1.99.0

type GetRelationalDatabaseBundlesInput struct {

	// A token used for advancing to a specific page of results for your get relational
	// database bundles request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseBundlesInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseBundlesInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (GetRelationalDatabaseBundlesInput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseBundlesOutput added in v1.99.0

type GetRelationalDatabaseBundlesOutput struct {

	// An object describing the result of your get relational database bundles request.
	Bundles []*RelationalDatabaseBundle `locationName:"bundles" type:"list"`

	// A token used for advancing to the next page of results of your get relational
	// database bundles request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseBundlesOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseBundlesOutput) SetBundles added in v1.99.0

SetBundles sets the Bundles field's value.

func (*GetRelationalDatabaseBundlesOutput) SetNextPageToken added in v1.99.0

SetNextPageToken sets the NextPageToken field's value.

func (GetRelationalDatabaseBundlesOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseEventsInput added in v1.99.0

type GetRelationalDatabaseEventsInput struct {

	// 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 *int64 `locationName:"durationInMinutes" type:"integer"`

	// A token used for advancing to a specific page of results from for get relational
	// database events request.
	PageToken *string `locationName:"pageToken" type:"string"`

	// The name of the database from which to get events.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseEventsInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseEventsInput) SetDurationInMinutes added in v1.99.0

SetDurationInMinutes sets the DurationInMinutes field's value.

func (*GetRelationalDatabaseEventsInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (*GetRelationalDatabaseEventsInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseEventsInput) String added in v1.99.0

String returns the string representation

func (*GetRelationalDatabaseEventsInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type GetRelationalDatabaseEventsOutput added in v1.99.0

type GetRelationalDatabaseEventsOutput struct {

	// A token used for advancing to the next page of results from your get relational
	// database events request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// An object describing the result of your get relational database events request.
	RelationalDatabaseEvents []*RelationalDatabaseEvent `locationName:"relationalDatabaseEvents" type:"list"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseEventsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseEventsOutput) SetNextPageToken added in v1.99.0

SetNextPageToken sets the NextPageToken field's value.

func (*GetRelationalDatabaseEventsOutput) SetRelationalDatabaseEvents added in v1.99.0

SetRelationalDatabaseEvents sets the RelationalDatabaseEvents field's value.

func (GetRelationalDatabaseEventsOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseInput added in v1.99.0

type GetRelationalDatabaseInput struct {

	// The name of the database that you are looking up.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseInput) GoString added in v1.99.0

func (s GetRelationalDatabaseInput) GoString() string

GoString returns the string representation

func (*GetRelationalDatabaseInput) SetRelationalDatabaseName added in v1.99.0

func (s *GetRelationalDatabaseInput) SetRelationalDatabaseName(v string) *GetRelationalDatabaseInput

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseInput) String added in v1.99.0

String returns the string representation

func (*GetRelationalDatabaseInput) Validate added in v1.99.0

func (s *GetRelationalDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetRelationalDatabaseLogEventsInput added in v1.99.0

type GetRelationalDatabaseLogEventsInput struct {

	// The end of the time interval from which to get log events.
	//
	// Constraints:
	//
	//    * Specified in Universal Coordinated 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 `locationName:"endTime" type:"timestamp"`

	// The name of the log stream.
	//
	// Use the get relational database log streams operation to get a list of available
	// log streams.
	//
	// LogStreamName is a required field
	LogStreamName *string `locationName:"logStreamName" type:"string" required:"true"`

	// A token used for advancing to a specific page of results for your get relational
	// database log events request.
	PageToken *string `locationName:"pageToken" type:"string"`

	// The name of your database for which to get log events.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`

	// 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.
	//
	// Default: false
	StartFromHead *bool `locationName:"startFromHead" type:"boolean"`

	// The start of the time interval from which to get log events.
	//
	// Constraints:
	//
	//    * Specified in Universal Coordinated 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 `locationName:"startTime" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseLogEventsInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseLogEventsInput) SetEndTime added in v1.99.0

SetEndTime sets the EndTime field's value.

func (*GetRelationalDatabaseLogEventsInput) SetLogStreamName added in v1.99.0

SetLogStreamName sets the LogStreamName field's value.

func (*GetRelationalDatabaseLogEventsInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (*GetRelationalDatabaseLogEventsInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*GetRelationalDatabaseLogEventsInput) SetStartFromHead added in v1.99.0

SetStartFromHead sets the StartFromHead field's value.

func (*GetRelationalDatabaseLogEventsInput) SetStartTime added in v1.99.0

SetStartTime sets the StartTime field's value.

func (GetRelationalDatabaseLogEventsInput) String added in v1.99.0

String returns the string representation

func (*GetRelationalDatabaseLogEventsInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type GetRelationalDatabaseLogEventsOutput added in v1.99.0

type GetRelationalDatabaseLogEventsOutput struct {

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

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

	// An object describing the result of your get relational database log events
	// request.
	ResourceLogEvents []*LogEvent `locationName:"resourceLogEvents" type:"list"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseLogEventsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseLogEventsOutput) SetNextBackwardToken added in v1.99.0

SetNextBackwardToken sets the NextBackwardToken field's value.

func (*GetRelationalDatabaseLogEventsOutput) SetNextForwardToken added in v1.99.0

SetNextForwardToken sets the NextForwardToken field's value.

func (*GetRelationalDatabaseLogEventsOutput) SetResourceLogEvents added in v1.99.0

SetResourceLogEvents sets the ResourceLogEvents field's value.

func (GetRelationalDatabaseLogEventsOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseLogStreamsInput added in v1.99.0

type GetRelationalDatabaseLogStreamsInput struct {

	// The name of your database for which to get log streams.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseLogStreamsInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseLogStreamsInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseLogStreamsInput) String added in v1.99.0

String returns the string representation

func (*GetRelationalDatabaseLogStreamsInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type GetRelationalDatabaseLogStreamsOutput added in v1.99.0

type GetRelationalDatabaseLogStreamsOutput struct {

	// An object describing the result of your get relational database log streams
	// request.
	LogStreams []*string `locationName:"logStreams" type:"list"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseLogStreamsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseLogStreamsOutput) SetLogStreams added in v1.99.0

SetLogStreams sets the LogStreams field's value.

func (GetRelationalDatabaseLogStreamsOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseMasterUserPasswordInput added in v1.99.0

type GetRelationalDatabaseMasterUserPasswordInput struct {

	// 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 *string `locationName:"passwordVersion" type:"string" enum:"RelationalDatabasePasswordVersion"`

	// The name of your database for which to get the master user password.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseMasterUserPasswordInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseMasterUserPasswordInput) SetPasswordVersion added in v1.99.0

SetPasswordVersion sets the PasswordVersion field's value.

func (*GetRelationalDatabaseMasterUserPasswordInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseMasterUserPasswordInput) String added in v1.99.0

String returns the string representation

func (*GetRelationalDatabaseMasterUserPasswordInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type GetRelationalDatabaseMasterUserPasswordOutput added in v1.99.0

type GetRelationalDatabaseMasterUserPasswordOutput struct {

	// The timestamp when the specified version of the master user password was
	// created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The master user password for the password version specified.
	MasterUserPassword *string `locationName:"masterUserPassword" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseMasterUserPasswordOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseMasterUserPasswordOutput) SetCreatedAt added in v1.99.0

SetCreatedAt sets the CreatedAt field's value.

func (*GetRelationalDatabaseMasterUserPasswordOutput) SetMasterUserPassword added in v1.99.0

SetMasterUserPassword sets the MasterUserPassword field's value.

func (GetRelationalDatabaseMasterUserPasswordOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseMetricDataInput added in v1.99.0

type GetRelationalDatabaseMetricDataInput struct {

	// The end of the time interval from which to get metric data.
	//
	// Constraints:
	//
	//    * Specified in Universal Coordinated 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 is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The name of the metric data to return.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"RelationalDatabaseMetricName"`

	// The granularity, in seconds, of the returned data points.
	//
	// Period is a required field
	Period *int64 `locationName:"period" min:"60" type:"integer" required:"true"`

	// The name of your database from which to get metric data.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`

	// The start of the time interval from which to get metric data.
	//
	// Constraints:
	//
	//    * Specified in Universal Coordinated 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 is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

	// The array of statistics for your metric data request.
	//
	// Statistics is a required field
	Statistics []*string `locationName:"statistics" type:"list" required:"true"`

	// The unit for the metric data request.
	//
	// Unit is a required field
	Unit *string `locationName:"unit" type:"string" required:"true" enum:"MetricUnit"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseMetricDataInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseMetricDataInput) SetEndTime added in v1.99.0

SetEndTime sets the EndTime field's value.

func (*GetRelationalDatabaseMetricDataInput) SetMetricName added in v1.99.0

SetMetricName sets the MetricName field's value.

func (*GetRelationalDatabaseMetricDataInput) SetPeriod added in v1.99.0

SetPeriod sets the Period field's value.

func (*GetRelationalDatabaseMetricDataInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*GetRelationalDatabaseMetricDataInput) SetStartTime added in v1.99.0

SetStartTime sets the StartTime field's value.

func (*GetRelationalDatabaseMetricDataInput) SetStatistics added in v1.99.0

SetStatistics sets the Statistics field's value.

func (*GetRelationalDatabaseMetricDataInput) SetUnit added in v1.99.0

SetUnit sets the Unit field's value.

func (GetRelationalDatabaseMetricDataInput) String added in v1.99.0

String returns the string representation

func (*GetRelationalDatabaseMetricDataInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type GetRelationalDatabaseMetricDataOutput added in v1.99.0

type GetRelationalDatabaseMetricDataOutput struct {

	// An object describing the result of your get relational database metric data
	// request.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The name of the metric.
	MetricName *string `locationName:"metricName" type:"string" enum:"RelationalDatabaseMetricName"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseMetricDataOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseMetricDataOutput) SetMetricData added in v1.99.0

SetMetricData sets the MetricData field's value.

func (*GetRelationalDatabaseMetricDataOutput) SetMetricName added in v1.99.0

SetMetricName sets the MetricName field's value.

func (GetRelationalDatabaseMetricDataOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseOutput added in v1.99.0

type GetRelationalDatabaseOutput struct {

	// An object describing the specified database.
	RelationalDatabase *RelationalDatabase `locationName:"relationalDatabase" type:"structure"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseOutput) GoString added in v1.99.0

func (s GetRelationalDatabaseOutput) GoString() string

GoString returns the string representation

func (*GetRelationalDatabaseOutput) SetRelationalDatabase added in v1.99.0

SetRelationalDatabase sets the RelationalDatabase field's value.

func (GetRelationalDatabaseOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseParametersInput added in v1.99.0

type GetRelationalDatabaseParametersInput struct {

	// A token used for advancing to a specific page of results for your get relational
	// database parameters request.
	PageToken *string `locationName:"pageToken" type:"string"`

	// The name of your database for which to get parameters.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseParametersInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseParametersInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (*GetRelationalDatabaseParametersInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseParametersInput) String added in v1.99.0

String returns the string representation

func (*GetRelationalDatabaseParametersInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type GetRelationalDatabaseParametersOutput added in v1.99.0

type GetRelationalDatabaseParametersOutput struct {

	// A token used for advancing to the next page of results from your get static
	// IPs request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// An object describing the result of your get relational database parameters
	// request.
	Parameters []*RelationalDatabaseParameter `locationName:"parameters" type:"list"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseParametersOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseParametersOutput) SetNextPageToken added in v1.99.0

SetNextPageToken sets the NextPageToken field's value.

func (*GetRelationalDatabaseParametersOutput) SetParameters added in v1.99.0

SetParameters sets the Parameters field's value.

func (GetRelationalDatabaseParametersOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseSnapshotInput added in v1.99.0

type GetRelationalDatabaseSnapshotInput struct {

	// The name of the database snapshot for which to get information.
	//
	// RelationalDatabaseSnapshotName is a required field
	RelationalDatabaseSnapshotName *string `locationName:"relationalDatabaseSnapshotName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseSnapshotInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName added in v1.99.0

func (s *GetRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName(v string) *GetRelationalDatabaseSnapshotInput

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (GetRelationalDatabaseSnapshotInput) String added in v1.99.0

String returns the string representation

func (*GetRelationalDatabaseSnapshotInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type GetRelationalDatabaseSnapshotOutput added in v1.99.0

type GetRelationalDatabaseSnapshotOutput struct {

	// An object describing the specified database snapshot.
	RelationalDatabaseSnapshot *RelationalDatabaseSnapshot `locationName:"relationalDatabaseSnapshot" type:"structure"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseSnapshotOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseSnapshotOutput) SetRelationalDatabaseSnapshot added in v1.99.0

SetRelationalDatabaseSnapshot sets the RelationalDatabaseSnapshot field's value.

func (GetRelationalDatabaseSnapshotOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseSnapshotsInput added in v1.99.0

type GetRelationalDatabaseSnapshotsInput struct {

	// A token used for advancing to a specific page of results for your get relational
	// database snapshots request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseSnapshotsInput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseSnapshotsInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (GetRelationalDatabaseSnapshotsInput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabaseSnapshotsOutput added in v1.99.0

type GetRelationalDatabaseSnapshotsOutput struct {

	// A token used for advancing to the next page of results from your get relational
	// database snapshots request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// An object describing the result of your get relational database snapshots
	// request.
	RelationalDatabaseSnapshots []*RelationalDatabaseSnapshot `locationName:"relationalDatabaseSnapshots" type:"list"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseSnapshotsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*GetRelationalDatabaseSnapshotsOutput) SetNextPageToken added in v1.99.0

SetNextPageToken sets the NextPageToken field's value.

func (*GetRelationalDatabaseSnapshotsOutput) SetRelationalDatabaseSnapshots added in v1.99.0

SetRelationalDatabaseSnapshots sets the RelationalDatabaseSnapshots field's value.

func (GetRelationalDatabaseSnapshotsOutput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabasesInput added in v1.99.0

type GetRelationalDatabasesInput struct {

	// A token used for advancing to a specific page of results for your get relational
	// database request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabasesInput) GoString added in v1.99.0

func (s GetRelationalDatabasesInput) GoString() string

GoString returns the string representation

func (*GetRelationalDatabasesInput) SetPageToken added in v1.99.0

SetPageToken sets the PageToken field's value.

func (GetRelationalDatabasesInput) String added in v1.99.0

String returns the string representation

type GetRelationalDatabasesOutput added in v1.99.0

type GetRelationalDatabasesOutput struct {

	// A token used for advancing to the next page of results from your get relational
	// databases request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// An object describing the result of your get relational databases request.
	RelationalDatabases []*RelationalDatabase `locationName:"relationalDatabases" type:"list"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabasesOutput) GoString added in v1.99.0

func (s GetRelationalDatabasesOutput) GoString() string

GoString returns the string representation

func (*GetRelationalDatabasesOutput) SetNextPageToken added in v1.99.0

SetNextPageToken sets the NextPageToken field's value.

func (*GetRelationalDatabasesOutput) SetRelationalDatabases added in v1.99.0

SetRelationalDatabases sets the RelationalDatabases field's value.

func (GetRelationalDatabasesOutput) String added in v1.99.0

String returns the string representation

type GetStaticIpInput

type GetStaticIpInput struct {

	// The name of the static IP in Lightsail.
	//
	// StaticIpName is a required field
	StaticIpName *string `locationName:"staticIpName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetStaticIpInput) GoString

func (s GetStaticIpInput) GoString() string

GoString returns the string representation

func (*GetStaticIpInput) SetStaticIpName

func (s *GetStaticIpInput) SetStaticIpName(v string) *GetStaticIpInput

SetStaticIpName sets the StaticIpName field's value.

func (GetStaticIpInput) String

func (s GetStaticIpInput) String() string

String returns the string representation

func (*GetStaticIpInput) Validate

func (s *GetStaticIpInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetStaticIpOutput

type GetStaticIpOutput struct {

	// An array of key-value pairs containing information about the requested static
	// IP.
	StaticIp *StaticIp `locationName:"staticIp" type:"structure"`
	// contains filtered or unexported fields
}

func (GetStaticIpOutput) GoString

func (s GetStaticIpOutput) GoString() string

GoString returns the string representation

func (*GetStaticIpOutput) SetStaticIp

func (s *GetStaticIpOutput) SetStaticIp(v *StaticIp) *GetStaticIpOutput

SetStaticIp sets the StaticIp field's value.

func (GetStaticIpOutput) String

func (s GetStaticIpOutput) String() string

String returns the string representation

type GetStaticIpsInput

type GetStaticIpsInput struct {

	// A token used for advancing to the next page of results from your get static
	// IPs request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetStaticIpsInput) GoString

func (s GetStaticIpsInput) GoString() string

GoString returns the string representation

func (*GetStaticIpsInput) SetPageToken

func (s *GetStaticIpsInput) SetPageToken(v string) *GetStaticIpsInput

SetPageToken sets the PageToken field's value.

func (GetStaticIpsInput) String

func (s GetStaticIpsInput) String() string

String returns the string representation

type GetStaticIpsOutput

type GetStaticIpsOutput struct {

	// A token used for advancing to the next page of results from your get static
	// IPs request.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// An array of key-value pairs containing information about your get static
	// IPs request.
	StaticIps []*StaticIp `locationName:"staticIps" type:"list"`
	// contains filtered or unexported fields
}

func (GetStaticIpsOutput) GoString

func (s GetStaticIpsOutput) GoString() string

GoString returns the string representation

func (*GetStaticIpsOutput) SetNextPageToken

func (s *GetStaticIpsOutput) SetNextPageToken(v string) *GetStaticIpsOutput

SetNextPageToken sets the NextPageToken field's value.

func (*GetStaticIpsOutput) SetStaticIps

func (s *GetStaticIpsOutput) SetStaticIps(v []*StaticIp) *GetStaticIpsOutput

SetStaticIps sets the StaticIps field's value.

func (GetStaticIpsOutput) String

func (s GetStaticIpsOutput) String() string

String returns the string representation

type HostKeyAttributes added in v1.99.0

type HostKeyAttributes struct {

	// The SSH host key algorithm or the RDP certificate format.
	//
	// For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519,
	// etc. For RDP certificates, the algorithm is always x509-cert.
	Algorithm *string `locationName:"algorithm" type:"string"`

	// The SHA-1 fingerprint of the returned SSH host key or RDP certificate.
	//
	//    * Example of an SHA-1 SSH fingerprint: SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0
	//
	//    * Example of an SHA-1 RDP fingerprint: af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45
	FingerprintSHA1 *string `locationName:"fingerprintSHA1" type:"string"`

	// The SHA-256 fingerprint of the returned SSH host key or RDP certificate.
	//
	//    * Example of an SHA-256 SSH fingerprint: SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o
	//
	//    * Example of an SHA-256 RDP fingerprint: 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68
	FingerprintSHA256 *string `locationName:"fingerprintSHA256" type:"string"`

	// The returned RDP certificate is not valid after this point in time.
	//
	// This value is listed only for RDP certificates.
	NotValidAfter *time.Time `locationName:"notValidAfter" type:"timestamp"`

	// The returned RDP certificate is valid after this point in time.
	//
	// This value is listed only for RDP certificates.
	NotValidBefore *time.Time `locationName:"notValidBefore" type:"timestamp"`

	// The public SSH host key or the RDP certificate.
	PublicKey *string `locationName:"publicKey" type:"string"`

	// The time that the SSH host key or RDP certificate was recorded by Lightsail.
	WitnessedAt *time.Time `locationName:"witnessedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

Describes the public SSH host keys or the RDP certificate.

func (HostKeyAttributes) GoString added in v1.99.0

func (s HostKeyAttributes) GoString() string

GoString returns the string representation

func (*HostKeyAttributes) SetAlgorithm added in v1.99.0

func (s *HostKeyAttributes) SetAlgorithm(v string) *HostKeyAttributes

SetAlgorithm sets the Algorithm field's value.

func (*HostKeyAttributes) SetFingerprintSHA1 added in v1.99.0

func (s *HostKeyAttributes) SetFingerprintSHA1(v string) *HostKeyAttributes

SetFingerprintSHA1 sets the FingerprintSHA1 field's value.

func (*HostKeyAttributes) SetFingerprintSHA256 added in v1.99.0

func (s *HostKeyAttributes) SetFingerprintSHA256(v string) *HostKeyAttributes

SetFingerprintSHA256 sets the FingerprintSHA256 field's value.

func (*HostKeyAttributes) SetNotValidAfter added in v1.99.0

func (s *HostKeyAttributes) SetNotValidAfter(v time.Time) *HostKeyAttributes

SetNotValidAfter sets the NotValidAfter field's value.

func (*HostKeyAttributes) SetNotValidBefore added in v1.99.0

func (s *HostKeyAttributes) SetNotValidBefore(v time.Time) *HostKeyAttributes

SetNotValidBefore sets the NotValidBefore field's value.

func (*HostKeyAttributes) SetPublicKey added in v1.99.0

func (s *HostKeyAttributes) SetPublicKey(v string) *HostKeyAttributes

SetPublicKey sets the PublicKey field's value.

func (*HostKeyAttributes) SetWitnessedAt added in v1.99.0

func (s *HostKeyAttributes) SetWitnessedAt(v time.Time) *HostKeyAttributes

SetWitnessedAt sets the WitnessedAt field's value.

func (HostKeyAttributes) String added in v1.99.0

func (s HostKeyAttributes) String() string

String returns the string representation

type ImportKeyPairInput

type ImportKeyPairInput struct {

	// The name of the key pair for which you want to import the public key.
	//
	// KeyPairName is a required field
	KeyPairName *string `locationName:"keyPairName" type:"string" required:"true"`

	// A base64-encoded public key of the ssh-rsa type.
	//
	// PublicKeyBase64 is a required field
	PublicKeyBase64 *string `locationName:"publicKeyBase64" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ImportKeyPairInput) GoString

func (s ImportKeyPairInput) GoString() string

GoString returns the string representation

func (*ImportKeyPairInput) SetKeyPairName

func (s *ImportKeyPairInput) SetKeyPairName(v string) *ImportKeyPairInput

SetKeyPairName sets the KeyPairName field's value.

func (*ImportKeyPairInput) SetPublicKeyBase64

func (s *ImportKeyPairInput) SetPublicKeyBase64(v string) *ImportKeyPairInput

SetPublicKeyBase64 sets the PublicKeyBase64 field's value.

func (ImportKeyPairInput) String

func (s ImportKeyPairInput) String() string

String returns the string representation

func (*ImportKeyPairInput) Validate

func (s *ImportKeyPairInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportKeyPairOutput

type ImportKeyPairOutput struct {

	// An array of key-value pairs containing information about the request operation.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (ImportKeyPairOutput) GoString

func (s ImportKeyPairOutput) GoString() string

GoString returns the string representation

func (*ImportKeyPairOutput) SetOperation

func (s *ImportKeyPairOutput) SetOperation(v *Operation) *ImportKeyPairOutput

SetOperation sets the Operation field's value.

func (ImportKeyPairOutput) String

func (s ImportKeyPairOutput) String() string

String returns the string representation

type Instance

type Instance struct {

	// The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
	Arn *string `locationName:"arn" type:"string"`

	// The blueprint ID (e.g., os_amlinux_2016_03).
	BlueprintId *string `locationName:"blueprintId" type:"string"`

	// The friendly name of the blueprint (e.g., Amazon Linux).
	BlueprintName *string `locationName:"blueprintName" type:"string"`

	// The bundle for the instance (e.g., micro_1_0).
	BundleId *string `locationName:"bundleId" type:"string"`

	// The timestamp when the instance was created (e.g., 1479734909.17).
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The size of the vCPU and the amount of RAM for the instance.
	Hardware *InstanceHardware `locationName:"hardware" type:"structure"`

	// The IPv6 address of the instance.
	Ipv6Address *string `locationName:"ipv6Address" type:"string"`

	// A Boolean value indicating whether this instance has a static IP assigned
	// to it.
	IsStaticIp *bool `locationName:"isStaticIp" type:"boolean"`

	// The region name and Availability Zone where the instance is located.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
	Name *string `locationName:"name" type:"string"`

	// Information about the public ports and monthly data transfer rates for the
	// instance.
	Networking *InstanceNetworking `locationName:"networking" type:"structure"`

	// The private IP address of the instance.
	PrivateIpAddress *string `locationName:"privateIpAddress" type:"string"`

	// The public IP address of the instance.
	PublicIpAddress *string `locationName:"publicIpAddress" type:"string"`

	// The type of resource (usually Instance).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
	SshKeyName *string `locationName:"sshKeyName" type:"string"`

	// The status code and the state (e.g., running) for the instance.
	State *InstanceState `locationName:"state" type:"structure"`

	// The support code. Include this code in your email to support when you have
	// questions about an instance or another resource in Lightsail. This code enables
	// our support team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`

	// The user name for connecting to the instance (e.g., ec2-user).
	Username *string `locationName:"username" type:"string"`
	// contains filtered or unexported fields
}

Describes an instance (a virtual private server).

func (Instance) GoString

func (s Instance) GoString() string

GoString returns the string representation

func (*Instance) SetArn

func (s *Instance) SetArn(v string) *Instance

SetArn sets the Arn field's value.

func (*Instance) SetBlueprintId

func (s *Instance) SetBlueprintId(v string) *Instance

SetBlueprintId sets the BlueprintId field's value.

func (*Instance) SetBlueprintName

func (s *Instance) SetBlueprintName(v string) *Instance

SetBlueprintName sets the BlueprintName field's value.

func (*Instance) SetBundleId

func (s *Instance) SetBundleId(v string) *Instance

SetBundleId sets the BundleId field's value.

func (*Instance) SetCreatedAt

func (s *Instance) SetCreatedAt(v time.Time) *Instance

SetCreatedAt sets the CreatedAt field's value.

func (*Instance) SetHardware

func (s *Instance) SetHardware(v *InstanceHardware) *Instance

SetHardware sets the Hardware field's value.

func (*Instance) SetIpv6Address

func (s *Instance) SetIpv6Address(v string) *Instance

SetIpv6Address sets the Ipv6Address field's value.

func (*Instance) SetIsStaticIp

func (s *Instance) SetIsStaticIp(v bool) *Instance

SetIsStaticIp sets the IsStaticIp field's value.

func (*Instance) SetLocation

func (s *Instance) SetLocation(v *ResourceLocation) *Instance

SetLocation sets the Location field's value.

func (*Instance) SetName

func (s *Instance) SetName(v string) *Instance

SetName sets the Name field's value.

func (*Instance) SetNetworking

func (s *Instance) SetNetworking(v *InstanceNetworking) *Instance

SetNetworking sets the Networking field's value.

func (*Instance) SetPrivateIpAddress

func (s *Instance) SetPrivateIpAddress(v string) *Instance

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (*Instance) SetPublicIpAddress

func (s *Instance) SetPublicIpAddress(v string) *Instance

SetPublicIpAddress sets the PublicIpAddress field's value.

func (*Instance) SetResourceType

func (s *Instance) SetResourceType(v string) *Instance

SetResourceType sets the ResourceType field's value.

func (*Instance) SetSshKeyName

func (s *Instance) SetSshKeyName(v string) *Instance

SetSshKeyName sets the SshKeyName field's value.

func (*Instance) SetState

func (s *Instance) SetState(v *InstanceState) *Instance

SetState sets the State field's value.

func (*Instance) SetSupportCode

func (s *Instance) SetSupportCode(v string) *Instance

SetSupportCode sets the SupportCode field's value.

func (*Instance) SetTags added in v1.99.0

func (s *Instance) SetTags(v []*Tag) *Instance

SetTags sets the Tags field's value.

func (*Instance) SetUsername

func (s *Instance) SetUsername(v string) *Instance

SetUsername sets the Username field's value.

func (Instance) String

func (s Instance) String() string

String returns the string representation

type InstanceAccessDetails

type InstanceAccessDetails struct {

	// For SSH access, the public key to use when accessing your instance For OpenSSH
	// clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.
	CertKey *string `locationName:"certKey" type:"string"`

	// For SSH access, the date on which the temporary keys expire.
	ExpiresAt *time.Time `locationName:"expiresAt" type:"timestamp"`

	// Describes the public SSH host keys or the RDP certificate.
	HostKeys []*HostKeyAttributes `locationName:"hostKeys" type:"list"`

	// The name of this Amazon Lightsail instance.
	InstanceName *string `locationName:"instanceName" type:"string"`

	// The public IP address of the Amazon Lightsail instance.
	IpAddress *string `locationName:"ipAddress" type:"string"`

	// For RDP access, the password for your Amazon Lightsail instance. Password
	// will be an empty string if the password for your new instance is not ready
	// yet. When you create an instance, it can take up to 15 minutes for the instance
	// to be ready.
	//
	// If you create an instance using any key pair other than the default (LightsailDefaultKeyPair),
	// password will always be an empty string.
	//
	// If you change the Administrator password on the instance, Lightsail will
	// continue to return the original password value. When accessing the instance
	// using RDP, you need to manually enter the Administrator password after changing
	// it from the default.
	Password *string `locationName:"password" type:"string"`

	// For a Windows Server-based instance, an object with the data you can use
	// to retrieve your password. This is only needed if password is empty and the
	// instance is not new (and therefore the password is not ready yet). When you
	// create an instance, it can take up to 15 minutes for the instance to be ready.
	PasswordData *PasswordData `locationName:"passwordData" type:"structure"`

	// For SSH access, the temporary private key. For OpenSSH clients (e.g., command
	// line SSH), you should save this value to tempkey).
	PrivateKey *string `locationName:"privateKey" type:"string"`

	// The protocol for these Amazon Lightsail instance access details.
	Protocol *string `locationName:"protocol" type:"string" enum:"InstanceAccessProtocol"`

	// The user name to use when logging in to the Amazon Lightsail instance.
	Username *string `locationName:"username" type:"string"`
	// contains filtered or unexported fields
}

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

func (InstanceAccessDetails) GoString

func (s InstanceAccessDetails) GoString() string

GoString returns the string representation

func (*InstanceAccessDetails) SetCertKey

SetCertKey sets the CertKey field's value.

func (*InstanceAccessDetails) SetExpiresAt

SetExpiresAt sets the ExpiresAt field's value.

func (*InstanceAccessDetails) SetHostKeys added in v1.99.0

SetHostKeys sets the HostKeys field's value.

func (*InstanceAccessDetails) SetInstanceName

func (s *InstanceAccessDetails) SetInstanceName(v string) *InstanceAccessDetails

SetInstanceName sets the InstanceName field's value.

func (*InstanceAccessDetails) SetIpAddress

SetIpAddress sets the IpAddress field's value.

func (*InstanceAccessDetails) SetPassword

SetPassword sets the Password field's value.

func (*InstanceAccessDetails) SetPasswordData added in v1.12.13

SetPasswordData sets the PasswordData field's value.

func (*InstanceAccessDetails) SetPrivateKey

func (s *InstanceAccessDetails) SetPrivateKey(v string) *InstanceAccessDetails

SetPrivateKey sets the PrivateKey field's value.

func (*InstanceAccessDetails) SetProtocol

SetProtocol sets the Protocol field's value.

func (*InstanceAccessDetails) SetUsername

SetUsername sets the Username field's value.

func (InstanceAccessDetails) String

func (s InstanceAccessDetails) String() string

String returns the string representation

type InstanceEntry added in v1.99.0

type InstanceEntry struct {

	// The Availability Zone for the new Amazon EC2 instance.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `locationName:"availabilityZone" type:"string" required:"true"`

	// The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.
	//
	// InstanceType is a required field
	InstanceType *string `locationName:"instanceType" type:"string" required:"true"`

	// The port configuration to use for the new Amazon EC2 instance.
	//
	// The following configuration options are available:
	//
	//    * DEFAULT — Use the default firewall settings from the image.
	//
	//    * INSTANCE — Use the firewall settings from the source Lightsail instance.
	//
	//    * NONE — Default to Amazon EC2.
	//
	//    * CLOSED — All ports closed.
	//
	// PortInfoSource is a required field
	PortInfoSource *string `locationName:"portInfoSource" type:"string" required:"true" enum:"PortInfoSourceType"`

	// The name of the export snapshot record, which contains the exported Lightsail
	// instance snapshot that will be used as the source of the new Amazon EC2 instance.
	//
	// Use the get export snapshot records operation to get a list of export snapshot
	// records that you can use to create a CloudFormation stack.
	//
	// SourceName is a required field
	SourceName *string `locationName:"sourceName" type:"string" required:"true"`

	// 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.
	UserData *string `locationName:"userData" type:"string"`
	// contains filtered or unexported fields
}

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack operation.

func (InstanceEntry) GoString added in v1.99.0

func (s InstanceEntry) GoString() string

GoString returns the string representation

func (*InstanceEntry) SetAvailabilityZone added in v1.99.0

func (s *InstanceEntry) SetAvailabilityZone(v string) *InstanceEntry

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*InstanceEntry) SetInstanceType added in v1.99.0

func (s *InstanceEntry) SetInstanceType(v string) *InstanceEntry

SetInstanceType sets the InstanceType field's value.

func (*InstanceEntry) SetPortInfoSource added in v1.99.0

func (s *InstanceEntry) SetPortInfoSource(v string) *InstanceEntry

SetPortInfoSource sets the PortInfoSource field's value.

func (*InstanceEntry) SetSourceName added in v1.99.0

func (s *InstanceEntry) SetSourceName(v string) *InstanceEntry

SetSourceName sets the SourceName field's value.

func (*InstanceEntry) SetUserData added in v1.99.0

func (s *InstanceEntry) SetUserData(v string) *InstanceEntry

SetUserData sets the UserData field's value.

func (InstanceEntry) String added in v1.99.0

func (s InstanceEntry) String() string

String returns the string representation

func (*InstanceEntry) Validate added in v1.99.0

func (s *InstanceEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InstanceHardware

type InstanceHardware struct {

	// The number of vCPUs the instance has.
	CpuCount *int64 `locationName:"cpuCount" type:"integer"`

	// The disks attached to the instance.
	Disks []*Disk `locationName:"disks" type:"list"`

	// The amount of RAM in GB on the instance (e.g., 1.0).
	RamSizeInGb *float64 `locationName:"ramSizeInGb" type:"float"`
	// contains filtered or unexported fields
}

Describes the hardware for the instance.

func (InstanceHardware) GoString

func (s InstanceHardware) GoString() string

GoString returns the string representation

func (*InstanceHardware) SetCpuCount

func (s *InstanceHardware) SetCpuCount(v int64) *InstanceHardware

SetCpuCount sets the CpuCount field's value.

func (*InstanceHardware) SetDisks

func (s *InstanceHardware) SetDisks(v []*Disk) *InstanceHardware

SetDisks sets the Disks field's value.

func (*InstanceHardware) SetRamSizeInGb

func (s *InstanceHardware) SetRamSizeInGb(v float64) *InstanceHardware

SetRamSizeInGb sets the RamSizeInGb field's value.

func (InstanceHardware) String

func (s InstanceHardware) String() string

String returns the string representation

type InstanceHealthSummary added in v1.12.37

type InstanceHealthSummary struct {

	// Describes the overall instance health. Valid values are below.
	InstanceHealth *string `locationName:"instanceHealth" type:"string" enum:"InstanceHealthState"`

	// More information about the instance health. If the instanceHealth is healthy,
	// then an instanceHealthReason value is not provided.
	//
	// If instanceHealth is initial, the instanceHealthReason value can be one of
	// the following:
	//
	//    * Lb.RegistrationInProgress - The target instance is in the process of
	//    being registered with the load balancer.
	//
	//    * Lb.InitialHealthChecking - The Lightsail load balancer is still sending
	//    the target instance the minimum number of health checks required to determine
	//    its health status.
	//
	// If instanceHealth is unhealthy, the instanceHealthReason value can be one
	// of the following:
	//
	//    * Instance.ResponseCodeMismatch - The health checks did not return an
	//    expected HTTP code.
	//
	//    * Instance.Timeout - The health check requests timed out.
	//
	//    * Instance.FailedHealthChecks - The health checks failed because the connection
	//    to the target instance timed out, the target instance response was malformed,
	//    or the target instance failed the health check for an unknown reason.
	//
	//    * Lb.InternalError - The health checks failed due to an internal error.
	//
	// If instanceHealth is unused, the instanceHealthReason value can be one of
	// the following:
	//
	//    * Instance.NotRegistered - The target instance is not registered with
	//    the target group.
	//
	//    * Instance.NotInUse - The target group is not used by any load balancer,
	//    or the target instance is in an Availability Zone that is not enabled
	//    for its load balancer.
	//
	//    * Instance.IpUnusable - The target IP address is reserved for use by a
	//    Lightsail load balancer.
	//
	//    * Instance.InvalidState - The target is in the stopped or terminated state.
	//
	// If instanceHealth is draining, the instanceHealthReason value can be one
	// of the following:
	//
	//    * Instance.DeregistrationInProgress - The target instance is in the process
	//    of being deregistered and the deregistration delay period has not expired.
	InstanceHealthReason *string `locationName:"instanceHealthReason" type:"string" enum:"InstanceHealthReason"`

	// The name of the Lightsail instance for which you are requesting health check
	// data.
	InstanceName *string `locationName:"instanceName" type:"string"`
	// contains filtered or unexported fields
}

Describes information about the health of the instance.

func (InstanceHealthSummary) GoString added in v1.12.37

func (s InstanceHealthSummary) GoString() string

GoString returns the string representation

func (*InstanceHealthSummary) SetInstanceHealth added in v1.12.37

func (s *InstanceHealthSummary) SetInstanceHealth(v string) *InstanceHealthSummary

SetInstanceHealth sets the InstanceHealth field's value.

func (*InstanceHealthSummary) SetInstanceHealthReason added in v1.12.37

func (s *InstanceHealthSummary) SetInstanceHealthReason(v string) *InstanceHealthSummary

SetInstanceHealthReason sets the InstanceHealthReason field's value.

func (*InstanceHealthSummary) SetInstanceName added in v1.12.37

func (s *InstanceHealthSummary) SetInstanceName(v string) *InstanceHealthSummary

SetInstanceName sets the InstanceName field's value.

func (InstanceHealthSummary) String added in v1.12.37

func (s InstanceHealthSummary) String() string

String returns the string representation

type InstanceNetworking

type InstanceNetworking struct {

	// The amount of data in GB allocated for monthly data transfers.
	MonthlyTransfer *MonthlyTransfer `locationName:"monthlyTransfer" type:"structure"`

	// An array of key-value pairs containing information about the ports on the
	// instance.
	Ports []*InstancePortInfo `locationName:"ports" type:"list"`
	// contains filtered or unexported fields
}

Describes monthly data transfer rates and port information for an instance.

func (InstanceNetworking) GoString

func (s InstanceNetworking) GoString() string

GoString returns the string representation

func (*InstanceNetworking) SetMonthlyTransfer

func (s *InstanceNetworking) SetMonthlyTransfer(v *MonthlyTransfer) *InstanceNetworking

SetMonthlyTransfer sets the MonthlyTransfer field's value.

func (*InstanceNetworking) SetPorts

SetPorts sets the Ports field's value.

func (InstanceNetworking) String

func (s InstanceNetworking) String() string

String returns the string representation

type InstancePortInfo

type InstancePortInfo struct {

	// The access direction (inbound or outbound).
	AccessDirection *string `locationName:"accessDirection" type:"string" enum:"AccessDirection"`

	// The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
	AccessFrom *string `locationName:"accessFrom" type:"string"`

	// The type of access (Public or Private).
	AccessType *string `locationName:"accessType" type:"string" enum:"PortAccessType"`

	// The common name.
	CommonName *string `locationName:"commonName" type:"string"`

	// The first port in the range.
	FromPort *int64 `locationName:"fromPort" type:"integer"`

	// The protocol being used. Can be one of the following.
	//
	//    * tcp - Transmission Control Protocol (TCP) provides reliable, ordered,
	//    and error-checked delivery of streamed data between applications running
	//    on hosts communicating by an IP network. If you have an application that
	//    doesn't require reliable data stream service, use UDP instead.
	//
	//    * all - All transport layer protocol types. For more general information,
	//    see Transport layer (https://en.wikipedia.org/wiki/Transport_layer) on
	//    Wikipedia.
	//
	//    * udp - With User Datagram Protocol (UDP), computer applications can send
	//    messages (or datagrams) to other hosts on an Internet Protocol (IP) network.
	//    Prior communications are not required to set up transmission channels
	//    or data paths. Applications that don't require reliable data stream service
	//    can use UDP, which provides a connectionless datagram service that emphasizes
	//    reduced latency over reliability. If you do require reliable data stream
	//    service, use TCP instead.
	Protocol *string `locationName:"protocol" type:"string" enum:"NetworkProtocol"`

	// The last port in the range.
	ToPort *int64 `locationName:"toPort" type:"integer"`
	// contains filtered or unexported fields
}

Describes information about the instance ports.

func (InstancePortInfo) GoString

func (s InstancePortInfo) GoString() string

GoString returns the string representation

func (*InstancePortInfo) SetAccessDirection

func (s *InstancePortInfo) SetAccessDirection(v string) *InstancePortInfo

SetAccessDirection sets the AccessDirection field's value.

func (*InstancePortInfo) SetAccessFrom

func (s *InstancePortInfo) SetAccessFrom(v string) *InstancePortInfo

SetAccessFrom sets the AccessFrom field's value.

func (*InstancePortInfo) SetAccessType

func (s *InstancePortInfo) SetAccessType(v string) *InstancePortInfo

SetAccessType sets the AccessType field's value.

func (*InstancePortInfo) SetCommonName

func (s *InstancePortInfo) SetCommonName(v string) *InstancePortInfo

SetCommonName sets the CommonName field's value.

func (*InstancePortInfo) SetFromPort

func (s *InstancePortInfo) SetFromPort(v int64) *InstancePortInfo

SetFromPort sets the FromPort field's value.

func (*InstancePortInfo) SetProtocol

func (s *InstancePortInfo) SetProtocol(v string) *InstancePortInfo

SetProtocol sets the Protocol field's value.

func (*InstancePortInfo) SetToPort

func (s *InstancePortInfo) SetToPort(v int64) *InstancePortInfo

SetToPort sets the ToPort field's value.

func (InstancePortInfo) String

func (s InstancePortInfo) String() string

String returns the string representation

type InstancePortState added in v1.8.26

type InstancePortState struct {

	// The first port in the range.
	FromPort *int64 `locationName:"fromPort" type:"integer"`

	// The protocol being used. Can be one of the following.
	//
	//    * tcp - Transmission Control Protocol (TCP) provides reliable, ordered,
	//    and error-checked delivery of streamed data between applications running
	//    on hosts communicating by an IP network. If you have an application that
	//    doesn't require reliable data stream service, use UDP instead.
	//
	//    * all - All transport layer protocol types. For more general information,
	//    see Transport layer (https://en.wikipedia.org/wiki/Transport_layer) on
	//    Wikipedia.
	//
	//    * udp - With User Datagram Protocol (UDP), computer applications can send
	//    messages (or datagrams) to other hosts on an Internet Protocol (IP) network.
	//    Prior communications are not required to set up transmission channels
	//    or data paths. Applications that don't require reliable data stream service
	//    can use UDP, which provides a connectionless datagram service that emphasizes
	//    reduced latency over reliability. If you do require reliable data stream
	//    service, use TCP instead.
	Protocol *string `locationName:"protocol" type:"string" enum:"NetworkProtocol"`

	// Specifies whether the instance port is open or closed.
	State *string `locationName:"state" type:"string" enum:"PortState"`

	// The last port in the range.
	ToPort *int64 `locationName:"toPort" type:"integer"`
	// contains filtered or unexported fields
}

Describes the port state.

func (InstancePortState) GoString added in v1.8.26

func (s InstancePortState) GoString() string

GoString returns the string representation

func (*InstancePortState) SetFromPort added in v1.8.26

func (s *InstancePortState) SetFromPort(v int64) *InstancePortState

SetFromPort sets the FromPort field's value.

func (*InstancePortState) SetProtocol added in v1.8.26

func (s *InstancePortState) SetProtocol(v string) *InstancePortState

SetProtocol sets the Protocol field's value.

func (*InstancePortState) SetState added in v1.8.26

func (s *InstancePortState) SetState(v string) *InstancePortState

SetState sets the State field's value.

func (*InstancePortState) SetToPort added in v1.8.26

func (s *InstancePortState) SetToPort(v int64) *InstancePortState

SetToPort sets the ToPort field's value.

func (InstancePortState) String added in v1.8.26

func (s InstancePortState) String() string

String returns the string representation

type InstanceSnapshot

type InstanceSnapshot struct {

	// The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
	Arn *string `locationName:"arn" type:"string"`

	// The timestamp when the snapshot was created (e.g., 1479907467.024).
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// An array of disk objects containing information about all block storage disks.
	FromAttachedDisks []*Disk `locationName:"fromAttachedDisks" type:"list"`

	// The blueprint ID from which you created the snapshot (e.g., os_debian_8_3).
	// A blueprint is a virtual private server (or instance) image used to create
	// instances quickly.
	FromBlueprintId *string `locationName:"fromBlueprintId" type:"string"`

	// The bundle ID from which you created the snapshot (e.g., micro_1_0).
	FromBundleId *string `locationName:"fromBundleId" type:"string"`

	// The Amazon Resource Name (ARN) of the instance from which the snapshot was
	// created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
	FromInstanceArn *string `locationName:"fromInstanceArn" type:"string"`

	// The instance from which the snapshot was created.
	FromInstanceName *string `locationName:"fromInstanceName" type:"string"`

	// The region name and Availability Zone where you created the snapshot.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the snapshot.
	Name *string `locationName:"name" type:"string"`

	// The progress of the snapshot.
	Progress *string `locationName:"progress" type:"string"`

	// The type of resource (usually InstanceSnapshot).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The size in GB of the SSD.
	SizeInGb *int64 `locationName:"sizeInGb" type:"integer"`

	// The state the snapshot is in.
	State *string `locationName:"state" type:"string" enum:"InstanceSnapshotState"`

	// The support code. Include this code in your email to support when you have
	// questions about an instance or another resource in Lightsail. This code enables
	// our support team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes the snapshot of the virtual private server, or instance.

func (InstanceSnapshot) GoString

func (s InstanceSnapshot) GoString() string

GoString returns the string representation

func (*InstanceSnapshot) SetArn

SetArn sets the Arn field's value.

func (*InstanceSnapshot) SetCreatedAt

func (s *InstanceSnapshot) SetCreatedAt(v time.Time) *InstanceSnapshot

SetCreatedAt sets the CreatedAt field's value.

func (*InstanceSnapshot) SetFromAttachedDisks added in v1.12.27

func (s *InstanceSnapshot) SetFromAttachedDisks(v []*Disk) *InstanceSnapshot

SetFromAttachedDisks sets the FromAttachedDisks field's value.

func (*InstanceSnapshot) SetFromBlueprintId

func (s *InstanceSnapshot) SetFromBlueprintId(v string) *InstanceSnapshot

SetFromBlueprintId sets the FromBlueprintId field's value.

func (*InstanceSnapshot) SetFromBundleId

func (s *InstanceSnapshot) SetFromBundleId(v string) *InstanceSnapshot

SetFromBundleId sets the FromBundleId field's value.

func (*InstanceSnapshot) SetFromInstanceArn

func (s *InstanceSnapshot) SetFromInstanceArn(v string) *InstanceSnapshot

SetFromInstanceArn sets the FromInstanceArn field's value.

func (*InstanceSnapshot) SetFromInstanceName

func (s *InstanceSnapshot) SetFromInstanceName(v string) *InstanceSnapshot

SetFromInstanceName sets the FromInstanceName field's value.

func (*InstanceSnapshot) SetLocation

SetLocation sets the Location field's value.

func (*InstanceSnapshot) SetName

func (s *InstanceSnapshot) SetName(v string) *InstanceSnapshot

SetName sets the Name field's value.

func (*InstanceSnapshot) SetProgress

func (s *InstanceSnapshot) SetProgress(v string) *InstanceSnapshot

SetProgress sets the Progress field's value.

func (*InstanceSnapshot) SetResourceType

func (s *InstanceSnapshot) SetResourceType(v string) *InstanceSnapshot

SetResourceType sets the ResourceType field's value.

func (*InstanceSnapshot) SetSizeInGb

func (s *InstanceSnapshot) SetSizeInGb(v int64) *InstanceSnapshot

SetSizeInGb sets the SizeInGb field's value.

func (*InstanceSnapshot) SetState

func (s *InstanceSnapshot) SetState(v string) *InstanceSnapshot

SetState sets the State field's value.

func (*InstanceSnapshot) SetSupportCode

func (s *InstanceSnapshot) SetSupportCode(v string) *InstanceSnapshot

SetSupportCode sets the SupportCode field's value.

func (*InstanceSnapshot) SetTags added in v1.99.0

func (s *InstanceSnapshot) SetTags(v []*Tag) *InstanceSnapshot

SetTags sets the Tags field's value.

func (InstanceSnapshot) String

func (s InstanceSnapshot) String() string

String returns the string representation

type InstanceSnapshotInfo added in v1.99.0

type InstanceSnapshotInfo struct {

	// The blueprint ID from which the source instance (e.g., os_debian_8_3).
	FromBlueprintId *string `locationName:"fromBlueprintId" type:"string"`

	// The bundle ID from which the source instance was created (e.g., micro_1_0).
	FromBundleId *string `locationName:"fromBundleId" type:"string"`

	// A list of objects describing the disks that were attached to the source instance.
	FromDiskInfo []*DiskInfo `locationName:"fromDiskInfo" type:"list"`
	// contains filtered or unexported fields
}

Describes an instance snapshot.

func (InstanceSnapshotInfo) GoString added in v1.99.0

func (s InstanceSnapshotInfo) GoString() string

GoString returns the string representation

func (*InstanceSnapshotInfo) SetFromBlueprintId added in v1.99.0

func (s *InstanceSnapshotInfo) SetFromBlueprintId(v string) *InstanceSnapshotInfo

SetFromBlueprintId sets the FromBlueprintId field's value.

func (*InstanceSnapshotInfo) SetFromBundleId added in v1.99.0

func (s *InstanceSnapshotInfo) SetFromBundleId(v string) *InstanceSnapshotInfo

SetFromBundleId sets the FromBundleId field's value.

func (*InstanceSnapshotInfo) SetFromDiskInfo added in v1.99.0

func (s *InstanceSnapshotInfo) SetFromDiskInfo(v []*DiskInfo) *InstanceSnapshotInfo

SetFromDiskInfo sets the FromDiskInfo field's value.

func (InstanceSnapshotInfo) String added in v1.99.0

func (s InstanceSnapshotInfo) String() string

String returns the string representation

type InstanceState

type InstanceState struct {

	// The status code for the instance.
	Code *int64 `locationName:"code" type:"integer"`

	// The state of the instance (e.g., running or pending).
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Describes the virtual private server (or instance) status.

func (InstanceState) GoString

func (s InstanceState) GoString() string

GoString returns the string representation

func (*InstanceState) SetCode

func (s *InstanceState) SetCode(v int64) *InstanceState

SetCode sets the Code field's value.

func (*InstanceState) SetName

func (s *InstanceState) SetName(v string) *InstanceState

SetName sets the Name field's value.

func (InstanceState) String

func (s InstanceState) String() string

String returns the string representation

type IsVpcPeeredInput

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

func (IsVpcPeeredInput) GoString

func (s IsVpcPeeredInput) GoString() string

GoString returns the string representation

func (IsVpcPeeredInput) String

func (s IsVpcPeeredInput) String() string

String returns the string representation

type IsVpcPeeredOutput

type IsVpcPeeredOutput struct {

	// Returns true if the Lightsail VPC is peered; otherwise, false.
	IsPeered *bool `locationName:"isPeered" type:"boolean"`
	// contains filtered or unexported fields
}

func (IsVpcPeeredOutput) GoString

func (s IsVpcPeeredOutput) GoString() string

GoString returns the string representation

func (*IsVpcPeeredOutput) SetIsPeered

func (s *IsVpcPeeredOutput) SetIsPeered(v bool) *IsVpcPeeredOutput

SetIsPeered sets the IsPeered field's value.

func (IsVpcPeeredOutput) String

func (s IsVpcPeeredOutput) String() string

String returns the string representation

type KeyPair

type KeyPair struct {

	// The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
	Arn *string `locationName:"arn" type:"string"`

	// The timestamp when the key pair was created (e.g., 1479816991.349).
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The RSA fingerprint of the key pair.
	Fingerprint *string `locationName:"fingerprint" type:"string"`

	// The region name and Availability Zone where the key pair was created.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The friendly name of the SSH key pair.
	Name *string `locationName:"name" type:"string"`

	// The resource type (usually KeyPair).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The support code. Include this code in your email to support when you have
	// questions about an instance or another resource in Lightsail. This code enables
	// our support team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes the SSH key pair.

func (KeyPair) GoString

func (s KeyPair) GoString() string

GoString returns the string representation

func (*KeyPair) SetArn

func (s *KeyPair) SetArn(v string) *KeyPair

SetArn sets the Arn field's value.

func (*KeyPair) SetCreatedAt

func (s *KeyPair) SetCreatedAt(v time.Time) *KeyPair

SetCreatedAt sets the CreatedAt field's value.

func (*KeyPair) SetFingerprint

func (s *KeyPair) SetFingerprint(v string) *KeyPair

SetFingerprint sets the Fingerprint field's value.

func (*KeyPair) SetLocation

func (s *KeyPair) SetLocation(v *ResourceLocation) *KeyPair

SetLocation sets the Location field's value.

func (*KeyPair) SetName

func (s *KeyPair) SetName(v string) *KeyPair

SetName sets the Name field's value.

func (*KeyPair) SetResourceType

func (s *KeyPair) SetResourceType(v string) *KeyPair

SetResourceType sets the ResourceType field's value.

func (*KeyPair) SetSupportCode

func (s *KeyPair) SetSupportCode(v string) *KeyPair

SetSupportCode sets the SupportCode field's value.

func (*KeyPair) SetTags added in v1.99.0

func (s *KeyPair) SetTags(v []*Tag) *KeyPair

SetTags sets the Tags field's value.

func (KeyPair) String

func (s KeyPair) String() string

String returns the string representation

type Lightsail

type Lightsail struct {
	*client.Client
}

Lightsail provides the API operation methods for making requests to Amazon Lightsail. See this package's package overview docs for details on the service.

Lightsail methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Lightsail

New creates a new instance of the Lightsail client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a Lightsail client from just a session.
svc := lightsail.New(mySession)

// Create a Lightsail client with additional configuration
svc := lightsail.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Lightsail) AllocateStaticIp

func (c *Lightsail) AllocateStaticIp(input *AllocateStaticIpInput) (*AllocateStaticIpOutput, error)

AllocateStaticIp API operation for Amazon Lightsail.

Allocates a static IP address.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AllocateStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AllocateStaticIp

func (*Lightsail) AllocateStaticIpRequest

func (c *Lightsail) AllocateStaticIpRequest(input *AllocateStaticIpInput) (req *request.Request, output *AllocateStaticIpOutput)

AllocateStaticIpRequest generates a "aws/request.Request" representing the client's request for the AllocateStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AllocateStaticIp for more information on using the AllocateStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AllocateStaticIpRequest method.
req, resp := client.AllocateStaticIpRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AllocateStaticIp

func (*Lightsail) AllocateStaticIpWithContext added in v1.8.0

func (c *Lightsail) AllocateStaticIpWithContext(ctx aws.Context, input *AllocateStaticIpInput, opts ...request.Option) (*AllocateStaticIpOutput, error)

AllocateStaticIpWithContext is the same as AllocateStaticIp with the addition of the ability to pass a context and additional request options.

See AllocateStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) AttachDisk added in v1.12.27

func (c *Lightsail) AttachDisk(input *AttachDiskInput) (*AttachDiskOutput, error)

AttachDisk API operation for Amazon Lightsail.

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 diskName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AttachDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDisk

func (*Lightsail) AttachDiskRequest added in v1.12.27

func (c *Lightsail) AttachDiskRequest(input *AttachDiskInput) (req *request.Request, output *AttachDiskOutput)

AttachDiskRequest generates a "aws/request.Request" representing the client's request for the AttachDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachDisk for more information on using the AttachDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachDiskRequest method.
req, resp := client.AttachDiskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDisk

func (*Lightsail) AttachDiskWithContext added in v1.12.27

func (c *Lightsail) AttachDiskWithContext(ctx aws.Context, input *AttachDiskInput, opts ...request.Option) (*AttachDiskOutput, error)

AttachDiskWithContext is the same as AttachDisk with the addition of the ability to pass a context and additional request options.

See AttachDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) AttachInstancesToLoadBalancer added in v1.12.37

func (c *Lightsail) AttachInstancesToLoadBalancer(input *AttachInstancesToLoadBalancerInput) (*AttachInstancesToLoadBalancerOutput, error)

AttachInstancesToLoadBalancer API operation for Amazon Lightsail.

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 loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AttachInstancesToLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancer

func (*Lightsail) AttachInstancesToLoadBalancerRequest added in v1.12.37

func (c *Lightsail) AttachInstancesToLoadBalancerRequest(input *AttachInstancesToLoadBalancerInput) (req *request.Request, output *AttachInstancesToLoadBalancerOutput)

AttachInstancesToLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the AttachInstancesToLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachInstancesToLoadBalancer for more information on using the AttachInstancesToLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachInstancesToLoadBalancerRequest method.
req, resp := client.AttachInstancesToLoadBalancerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancer

func (*Lightsail) AttachInstancesToLoadBalancerWithContext added in v1.12.37

func (c *Lightsail) AttachInstancesToLoadBalancerWithContext(ctx aws.Context, input *AttachInstancesToLoadBalancerInput, opts ...request.Option) (*AttachInstancesToLoadBalancerOutput, error)

AttachInstancesToLoadBalancerWithContext is the same as AttachInstancesToLoadBalancer with the addition of the ability to pass a context and additional request options.

See AttachInstancesToLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) AttachLoadBalancerTlsCertificate added in v1.12.37

func (c *Lightsail) AttachLoadBalancerTlsCertificate(input *AttachLoadBalancerTlsCertificateInput) (*AttachLoadBalancerTlsCertificateOutput, error)

AttachLoadBalancerTlsCertificate API operation for Amazon Lightsail.

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 operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The attach load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AttachLoadBalancerTlsCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate

func (*Lightsail) AttachLoadBalancerTlsCertificateRequest added in v1.12.37

func (c *Lightsail) AttachLoadBalancerTlsCertificateRequest(input *AttachLoadBalancerTlsCertificateInput) (req *request.Request, output *AttachLoadBalancerTlsCertificateOutput)

AttachLoadBalancerTlsCertificateRequest generates a "aws/request.Request" representing the client's request for the AttachLoadBalancerTlsCertificate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachLoadBalancerTlsCertificate for more information on using the AttachLoadBalancerTlsCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachLoadBalancerTlsCertificateRequest method.
req, resp := client.AttachLoadBalancerTlsCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate

func (*Lightsail) AttachLoadBalancerTlsCertificateWithContext added in v1.12.37

func (c *Lightsail) AttachLoadBalancerTlsCertificateWithContext(ctx aws.Context, input *AttachLoadBalancerTlsCertificateInput, opts ...request.Option) (*AttachLoadBalancerTlsCertificateOutput, error)

AttachLoadBalancerTlsCertificateWithContext is the same as AttachLoadBalancerTlsCertificate with the addition of the ability to pass a context and additional request options.

See AttachLoadBalancerTlsCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) AttachStaticIp

func (c *Lightsail) AttachStaticIp(input *AttachStaticIpInput) (*AttachStaticIpOutput, error)

AttachStaticIp API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation AttachStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachStaticIp

func (*Lightsail) AttachStaticIpRequest

func (c *Lightsail) AttachStaticIpRequest(input *AttachStaticIpInput) (req *request.Request, output *AttachStaticIpOutput)

AttachStaticIpRequest generates a "aws/request.Request" representing the client's request for the AttachStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachStaticIp for more information on using the AttachStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachStaticIpRequest method.
req, resp := client.AttachStaticIpRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachStaticIp

func (*Lightsail) AttachStaticIpWithContext added in v1.8.0

func (c *Lightsail) AttachStaticIpWithContext(ctx aws.Context, input *AttachStaticIpInput, opts ...request.Option) (*AttachStaticIpOutput, error)

AttachStaticIpWithContext is the same as AttachStaticIp with the addition of the ability to pass a context and additional request options.

See AttachStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CloseInstancePublicPorts

func (c *Lightsail) CloseInstancePublicPorts(input *CloseInstancePublicPortsInput) (*CloseInstancePublicPortsOutput, error)

CloseInstancePublicPorts API operation for Amazon Lightsail.

Closes the public ports on a specific Amazon Lightsail instance.

The close instance public ports operation 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CloseInstancePublicPorts for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloseInstancePublicPorts

func (*Lightsail) CloseInstancePublicPortsRequest

func (c *Lightsail) CloseInstancePublicPortsRequest(input *CloseInstancePublicPortsInput) (req *request.Request, output *CloseInstancePublicPortsOutput)

CloseInstancePublicPortsRequest generates a "aws/request.Request" representing the client's request for the CloseInstancePublicPorts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CloseInstancePublicPorts for more information on using the CloseInstancePublicPorts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CloseInstancePublicPortsRequest method.
req, resp := client.CloseInstancePublicPortsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloseInstancePublicPorts

func (*Lightsail) CloseInstancePublicPortsWithContext added in v1.8.0

func (c *Lightsail) CloseInstancePublicPortsWithContext(ctx aws.Context, input *CloseInstancePublicPortsInput, opts ...request.Option) (*CloseInstancePublicPortsOutput, error)

CloseInstancePublicPortsWithContext is the same as CloseInstancePublicPorts with the addition of the ability to pass a context and additional request options.

See CloseInstancePublicPorts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CopySnapshot added in v1.99.0

func (c *Lightsail) CopySnapshot(input *CopySnapshotInput) (*CopySnapshotOutput, error)

CopySnapshot API operation for Amazon Lightsail.

Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CopySnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CopySnapshot

func (*Lightsail) CopySnapshotRequest added in v1.99.0

func (c *Lightsail) CopySnapshotRequest(input *CopySnapshotInput) (req *request.Request, output *CopySnapshotOutput)

CopySnapshotRequest generates a "aws/request.Request" representing the client's request for the CopySnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopySnapshot for more information on using the CopySnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopySnapshotRequest method.
req, resp := client.CopySnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CopySnapshot

func (*Lightsail) CopySnapshotWithContext added in v1.99.0

func (c *Lightsail) CopySnapshotWithContext(ctx aws.Context, input *CopySnapshotInput, opts ...request.Option) (*CopySnapshotOutput, error)

CopySnapshotWithContext is the same as CopySnapshot with the addition of the ability to pass a context and additional request options.

See CopySnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateCloudFormationStack added in v1.99.0

func (c *Lightsail) CreateCloudFormationStack(input *CreateCloudFormationStackInput) (*CreateCloudFormationStackOutput, error)

CreateCloudFormationStack API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateCloudFormationStack for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCloudFormationStack

func (*Lightsail) CreateCloudFormationStackRequest added in v1.99.0

func (c *Lightsail) CreateCloudFormationStackRequest(input *CreateCloudFormationStackInput) (req *request.Request, output *CreateCloudFormationStackOutput)

CreateCloudFormationStackRequest generates a "aws/request.Request" representing the client's request for the CreateCloudFormationStack operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCloudFormationStack for more information on using the CreateCloudFormationStack API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCloudFormationStackRequest method.
req, resp := client.CreateCloudFormationStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCloudFormationStack

func (*Lightsail) CreateCloudFormationStackWithContext added in v1.99.0

func (c *Lightsail) CreateCloudFormationStackWithContext(ctx aws.Context, input *CreateCloudFormationStackInput, opts ...request.Option) (*CreateCloudFormationStackOutput, error)

CreateCloudFormationStackWithContext is the same as CreateCloudFormationStack with the addition of the ability to pass a context and additional request options.

See CreateCloudFormationStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateDisk added in v1.12.27

func (c *Lightsail) CreateDisk(input *CreateDiskInput) (*CreateDiskOutput, error)

CreateDisk API operation for Amazon Lightsail.

Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail (https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDisk

func (*Lightsail) CreateDiskFromSnapshot added in v1.12.27

func (c *Lightsail) CreateDiskFromSnapshot(input *CreateDiskFromSnapshotInput) (*CreateDiskFromSnapshotOutput, error)

CreateDiskFromSnapshot API operation for Amazon Lightsail.

Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail (https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDiskFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskFromSnapshot

func (*Lightsail) CreateDiskFromSnapshotRequest added in v1.12.27

func (c *Lightsail) CreateDiskFromSnapshotRequest(input *CreateDiskFromSnapshotInput) (req *request.Request, output *CreateDiskFromSnapshotOutput)

CreateDiskFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateDiskFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDiskFromSnapshot for more information on using the CreateDiskFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDiskFromSnapshotRequest method.
req, resp := client.CreateDiskFromSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskFromSnapshot

func (*Lightsail) CreateDiskFromSnapshotWithContext added in v1.12.27

func (c *Lightsail) CreateDiskFromSnapshotWithContext(ctx aws.Context, input *CreateDiskFromSnapshotInput, opts ...request.Option) (*CreateDiskFromSnapshotOutput, error)

CreateDiskFromSnapshotWithContext is the same as CreateDiskFromSnapshot with the addition of the ability to pass a context and additional request options.

See CreateDiskFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateDiskRequest added in v1.12.27

func (c *Lightsail) CreateDiskRequest(input *CreateDiskInput) (req *request.Request, output *CreateDiskOutput)

CreateDiskRequest generates a "aws/request.Request" representing the client's request for the CreateDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDisk for more information on using the CreateDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDiskRequest method.
req, resp := client.CreateDiskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDisk

func (*Lightsail) CreateDiskSnapshot added in v1.12.27

func (c *Lightsail) CreateDiskSnapshot(input *CreateDiskSnapshotInput) (*CreateDiskSnapshotOutput, error)

CreateDiskSnapshot API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDiskSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskSnapshot

func (*Lightsail) CreateDiskSnapshotRequest added in v1.12.27

func (c *Lightsail) CreateDiskSnapshotRequest(input *CreateDiskSnapshotInput) (req *request.Request, output *CreateDiskSnapshotOutput)

CreateDiskSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateDiskSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDiskSnapshot for more information on using the CreateDiskSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDiskSnapshotRequest method.
req, resp := client.CreateDiskSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskSnapshot

func (*Lightsail) CreateDiskSnapshotWithContext added in v1.12.27

func (c *Lightsail) CreateDiskSnapshotWithContext(ctx aws.Context, input *CreateDiskSnapshotInput, opts ...request.Option) (*CreateDiskSnapshotOutput, error)

CreateDiskSnapshotWithContext is the same as CreateDiskSnapshot with the addition of the ability to pass a context and additional request options.

See CreateDiskSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateDiskWithContext added in v1.12.27

func (c *Lightsail) CreateDiskWithContext(ctx aws.Context, input *CreateDiskInput, opts ...request.Option) (*CreateDiskOutput, error)

CreateDiskWithContext is the same as CreateDisk with the addition of the ability to pass a context and additional request options.

See CreateDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateDomain

func (c *Lightsail) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error)

CreateDomain API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDomain for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomain

func (*Lightsail) CreateDomainEntry

func (c *Lightsail) CreateDomainEntry(input *CreateDomainEntryInput) (*CreateDomainEntryOutput, error)

CreateDomainEntry API operation for Amazon Lightsail.

Creates one of the following entry records associated with the domain: 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 domainName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateDomainEntry for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainEntry

func (*Lightsail) CreateDomainEntryRequest

func (c *Lightsail) CreateDomainEntryRequest(input *CreateDomainEntryInput) (req *request.Request, output *CreateDomainEntryOutput)

CreateDomainEntryRequest generates a "aws/request.Request" representing the client's request for the CreateDomainEntry operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDomainEntry for more information on using the CreateDomainEntry API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDomainEntryRequest method.
req, resp := client.CreateDomainEntryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainEntry

func (*Lightsail) CreateDomainEntryWithContext added in v1.8.0

func (c *Lightsail) CreateDomainEntryWithContext(ctx aws.Context, input *CreateDomainEntryInput, opts ...request.Option) (*CreateDomainEntryOutput, error)

CreateDomainEntryWithContext is the same as CreateDomainEntry with the addition of the ability to pass a context and additional request options.

See CreateDomainEntry for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateDomainRequest

func (c *Lightsail) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput)

CreateDomainRequest generates a "aws/request.Request" representing the client's request for the CreateDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDomain for more information on using the CreateDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDomainRequest method.
req, resp := client.CreateDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomain

func (*Lightsail) CreateDomainWithContext added in v1.8.0

func (c *Lightsail) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error)

CreateDomainWithContext is the same as CreateDomain with the addition of the ability to pass a context and additional request options.

See CreateDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateInstanceSnapshot

func (c *Lightsail) CreateInstanceSnapshot(input *CreateInstanceSnapshotInput) (*CreateInstanceSnapshotOutput, error)

CreateInstanceSnapshot API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateInstanceSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstanceSnapshot

func (*Lightsail) CreateInstanceSnapshotRequest

func (c *Lightsail) CreateInstanceSnapshotRequest(input *CreateInstanceSnapshotInput) (req *request.Request, output *CreateInstanceSnapshotOutput)

CreateInstanceSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateInstanceSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateInstanceSnapshot for more information on using the CreateInstanceSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateInstanceSnapshotRequest method.
req, resp := client.CreateInstanceSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstanceSnapshot

func (*Lightsail) CreateInstanceSnapshotWithContext added in v1.8.0

func (c *Lightsail) CreateInstanceSnapshotWithContext(ctx aws.Context, input *CreateInstanceSnapshotInput, opts ...request.Option) (*CreateInstanceSnapshotOutput, error)

CreateInstanceSnapshotWithContext is the same as CreateInstanceSnapshot with the addition of the ability to pass a context and additional request options.

See CreateInstanceSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateInstances

func (c *Lightsail) CreateInstances(input *CreateInstancesInput) (*CreateInstancesOutput, error)

CreateInstances API operation for Amazon Lightsail.

Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateInstances for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstances

func (*Lightsail) CreateInstancesFromSnapshot

func (c *Lightsail) CreateInstancesFromSnapshot(input *CreateInstancesFromSnapshotInput) (*CreateInstancesFromSnapshotOutput, error)

CreateInstancesFromSnapshot API operation for Amazon Lightsail.

Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateInstancesFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesFromSnapshot

func (*Lightsail) CreateInstancesFromSnapshotRequest

func (c *Lightsail) CreateInstancesFromSnapshotRequest(input *CreateInstancesFromSnapshotInput) (req *request.Request, output *CreateInstancesFromSnapshotOutput)

CreateInstancesFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateInstancesFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateInstancesFromSnapshot for more information on using the CreateInstancesFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateInstancesFromSnapshotRequest method.
req, resp := client.CreateInstancesFromSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesFromSnapshot

func (*Lightsail) CreateInstancesFromSnapshotWithContext added in v1.8.0

func (c *Lightsail) CreateInstancesFromSnapshotWithContext(ctx aws.Context, input *CreateInstancesFromSnapshotInput, opts ...request.Option) (*CreateInstancesFromSnapshotOutput, error)

CreateInstancesFromSnapshotWithContext is the same as CreateInstancesFromSnapshot with the addition of the ability to pass a context and additional request options.

See CreateInstancesFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateInstancesRequest

func (c *Lightsail) CreateInstancesRequest(input *CreateInstancesInput) (req *request.Request, output *CreateInstancesOutput)

CreateInstancesRequest generates a "aws/request.Request" representing the client's request for the CreateInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateInstances for more information on using the CreateInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateInstancesRequest method.
req, resp := client.CreateInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstances

func (*Lightsail) CreateInstancesWithContext added in v1.8.0

func (c *Lightsail) CreateInstancesWithContext(ctx aws.Context, input *CreateInstancesInput, opts ...request.Option) (*CreateInstancesOutput, error)

CreateInstancesWithContext is the same as CreateInstances with the addition of the ability to pass a context and additional request options.

See CreateInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateKeyPair

func (c *Lightsail) CreateKeyPair(input *CreateKeyPairInput) (*CreateKeyPairOutput, error)

CreateKeyPair API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateKeyPair

func (*Lightsail) CreateKeyPairRequest

func (c *Lightsail) CreateKeyPairRequest(input *CreateKeyPairInput) (req *request.Request, output *CreateKeyPairOutput)

CreateKeyPairRequest generates a "aws/request.Request" representing the client's request for the CreateKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateKeyPair for more information on using the CreateKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateKeyPairRequest method.
req, resp := client.CreateKeyPairRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateKeyPair

func (*Lightsail) CreateKeyPairWithContext added in v1.8.0

func (c *Lightsail) CreateKeyPairWithContext(ctx aws.Context, input *CreateKeyPairInput, opts ...request.Option) (*CreateKeyPairOutput, error)

CreateKeyPairWithContext is the same as CreateKeyPair with the addition of the ability to pass a context and additional request options.

See CreateKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateLoadBalancer added in v1.12.37

func (c *Lightsail) CreateLoadBalancer(input *CreateLoadBalancerInput) (*CreateLoadBalancerOutput, error)

CreateLoadBalancer API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancer

func (*Lightsail) CreateLoadBalancerRequest added in v1.12.37

func (c *Lightsail) CreateLoadBalancerRequest(input *CreateLoadBalancerInput) (req *request.Request, output *CreateLoadBalancerOutput)

CreateLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the CreateLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLoadBalancer for more information on using the CreateLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLoadBalancerRequest method.
req, resp := client.CreateLoadBalancerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancer

func (*Lightsail) CreateLoadBalancerTlsCertificate added in v1.12.37

func (c *Lightsail) CreateLoadBalancerTlsCertificate(input *CreateLoadBalancerTlsCertificateInput) (*CreateLoadBalancerTlsCertificateOutput, error)

CreateLoadBalancerTlsCertificate API operation for Amazon Lightsail.

Creates a Lightsail load balancer TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

The create load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateLoadBalancerTlsCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate

func (*Lightsail) CreateLoadBalancerTlsCertificateRequest added in v1.12.37

func (c *Lightsail) CreateLoadBalancerTlsCertificateRequest(input *CreateLoadBalancerTlsCertificateInput) (req *request.Request, output *CreateLoadBalancerTlsCertificateOutput)

CreateLoadBalancerTlsCertificateRequest generates a "aws/request.Request" representing the client's request for the CreateLoadBalancerTlsCertificate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLoadBalancerTlsCertificate for more information on using the CreateLoadBalancerTlsCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLoadBalancerTlsCertificateRequest method.
req, resp := client.CreateLoadBalancerTlsCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate

func (*Lightsail) CreateLoadBalancerTlsCertificateWithContext added in v1.12.37

func (c *Lightsail) CreateLoadBalancerTlsCertificateWithContext(ctx aws.Context, input *CreateLoadBalancerTlsCertificateInput, opts ...request.Option) (*CreateLoadBalancerTlsCertificateOutput, error)

CreateLoadBalancerTlsCertificateWithContext is the same as CreateLoadBalancerTlsCertificate with the addition of the ability to pass a context and additional request options.

See CreateLoadBalancerTlsCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateLoadBalancerWithContext added in v1.12.37

func (c *Lightsail) CreateLoadBalancerWithContext(ctx aws.Context, input *CreateLoadBalancerInput, opts ...request.Option) (*CreateLoadBalancerOutput, error)

CreateLoadBalancerWithContext is the same as CreateLoadBalancer with the addition of the ability to pass a context and additional request options.

See CreateLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateRelationalDatabase added in v1.99.0

func (c *Lightsail) CreateRelationalDatabase(input *CreateRelationalDatabaseInput) (*CreateRelationalDatabaseOutput, error)

CreateRelationalDatabase API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabase

func (*Lightsail) CreateRelationalDatabaseFromSnapshot added in v1.99.0

CreateRelationalDatabaseFromSnapshot API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateRelationalDatabaseFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot

func (*Lightsail) CreateRelationalDatabaseFromSnapshotRequest added in v1.99.0

func (c *Lightsail) CreateRelationalDatabaseFromSnapshotRequest(input *CreateRelationalDatabaseFromSnapshotInput) (req *request.Request, output *CreateRelationalDatabaseFromSnapshotOutput)

CreateRelationalDatabaseFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateRelationalDatabaseFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRelationalDatabaseFromSnapshot for more information on using the CreateRelationalDatabaseFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRelationalDatabaseFromSnapshotRequest method.
req, resp := client.CreateRelationalDatabaseFromSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot

func (*Lightsail) CreateRelationalDatabaseFromSnapshotWithContext added in v1.99.0

func (c *Lightsail) CreateRelationalDatabaseFromSnapshotWithContext(ctx aws.Context, input *CreateRelationalDatabaseFromSnapshotInput, opts ...request.Option) (*CreateRelationalDatabaseFromSnapshotOutput, error)

CreateRelationalDatabaseFromSnapshotWithContext is the same as CreateRelationalDatabaseFromSnapshot with the addition of the ability to pass a context and additional request options.

See CreateRelationalDatabaseFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateRelationalDatabaseRequest added in v1.99.0

func (c *Lightsail) CreateRelationalDatabaseRequest(input *CreateRelationalDatabaseInput) (req *request.Request, output *CreateRelationalDatabaseOutput)

CreateRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the CreateRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRelationalDatabase for more information on using the CreateRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRelationalDatabaseRequest method.
req, resp := client.CreateRelationalDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabase

func (*Lightsail) CreateRelationalDatabaseSnapshot added in v1.99.0

func (c *Lightsail) CreateRelationalDatabaseSnapshot(input *CreateRelationalDatabaseSnapshotInput) (*CreateRelationalDatabaseSnapshotOutput, error)

CreateRelationalDatabaseSnapshot API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation CreateRelationalDatabaseSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot

func (*Lightsail) CreateRelationalDatabaseSnapshotRequest added in v1.99.0

func (c *Lightsail) CreateRelationalDatabaseSnapshotRequest(input *CreateRelationalDatabaseSnapshotInput) (req *request.Request, output *CreateRelationalDatabaseSnapshotOutput)

CreateRelationalDatabaseSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateRelationalDatabaseSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRelationalDatabaseSnapshot for more information on using the CreateRelationalDatabaseSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRelationalDatabaseSnapshotRequest method.
req, resp := client.CreateRelationalDatabaseSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot

func (*Lightsail) CreateRelationalDatabaseSnapshotWithContext added in v1.99.0

func (c *Lightsail) CreateRelationalDatabaseSnapshotWithContext(ctx aws.Context, input *CreateRelationalDatabaseSnapshotInput, opts ...request.Option) (*CreateRelationalDatabaseSnapshotOutput, error)

CreateRelationalDatabaseSnapshotWithContext is the same as CreateRelationalDatabaseSnapshot with the addition of the ability to pass a context and additional request options.

See CreateRelationalDatabaseSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) CreateRelationalDatabaseWithContext added in v1.99.0

func (c *Lightsail) CreateRelationalDatabaseWithContext(ctx aws.Context, input *CreateRelationalDatabaseInput, opts ...request.Option) (*CreateRelationalDatabaseOutput, error)

CreateRelationalDatabaseWithContext is the same as CreateRelationalDatabase with the addition of the ability to pass a context and additional request options.

See CreateRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteDisk added in v1.12.27

func (c *Lightsail) DeleteDisk(input *DeleteDiskInput) (*DeleteDiskOutput, error)

DeleteDisk API operation for Amazon Lightsail.

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 diskName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDisk

func (*Lightsail) DeleteDiskRequest added in v1.12.27

func (c *Lightsail) DeleteDiskRequest(input *DeleteDiskInput) (req *request.Request, output *DeleteDiskOutput)

DeleteDiskRequest generates a "aws/request.Request" representing the client's request for the DeleteDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDisk for more information on using the DeleteDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDiskRequest method.
req, resp := client.DeleteDiskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDisk

func (*Lightsail) DeleteDiskSnapshot added in v1.12.27

func (c *Lightsail) DeleteDiskSnapshot(input *DeleteDiskSnapshotInput) (*DeleteDiskSnapshotOutput, error)

DeleteDiskSnapshot API operation for Amazon Lightsail.

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 diskSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteDiskSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskSnapshot

func (*Lightsail) DeleteDiskSnapshotRequest added in v1.12.27

func (c *Lightsail) DeleteDiskSnapshotRequest(input *DeleteDiskSnapshotInput) (req *request.Request, output *DeleteDiskSnapshotOutput)

DeleteDiskSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteDiskSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDiskSnapshot for more information on using the DeleteDiskSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDiskSnapshotRequest method.
req, resp := client.DeleteDiskSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskSnapshot

func (*Lightsail) DeleteDiskSnapshotWithContext added in v1.12.27

func (c *Lightsail) DeleteDiskSnapshotWithContext(ctx aws.Context, input *DeleteDiskSnapshotInput, opts ...request.Option) (*DeleteDiskSnapshotOutput, error)

DeleteDiskSnapshotWithContext is the same as DeleteDiskSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteDiskSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteDiskWithContext added in v1.12.27

func (c *Lightsail) DeleteDiskWithContext(ctx aws.Context, input *DeleteDiskInput, opts ...request.Option) (*DeleteDiskOutput, error)

DeleteDiskWithContext is the same as DeleteDisk with the addition of the ability to pass a context and additional request options.

See DeleteDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteDomain

func (c *Lightsail) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error)

DeleteDomain API operation for Amazon Lightsail.

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 domainName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteDomain for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomain

func (*Lightsail) DeleteDomainEntry

func (c *Lightsail) DeleteDomainEntry(input *DeleteDomainEntryInput) (*DeleteDomainEntryOutput, error)

DeleteDomainEntry API operation for Amazon Lightsail.

Deletes a specific domain entry.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteDomainEntry for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainEntry

func (*Lightsail) DeleteDomainEntryRequest

func (c *Lightsail) DeleteDomainEntryRequest(input *DeleteDomainEntryInput) (req *request.Request, output *DeleteDomainEntryOutput)

DeleteDomainEntryRequest generates a "aws/request.Request" representing the client's request for the DeleteDomainEntry operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDomainEntry for more information on using the DeleteDomainEntry API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDomainEntryRequest method.
req, resp := client.DeleteDomainEntryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainEntry

func (*Lightsail) DeleteDomainEntryWithContext added in v1.8.0

func (c *Lightsail) DeleteDomainEntryWithContext(ctx aws.Context, input *DeleteDomainEntryInput, opts ...request.Option) (*DeleteDomainEntryOutput, error)

DeleteDomainEntryWithContext is the same as DeleteDomainEntry with the addition of the ability to pass a context and additional request options.

See DeleteDomainEntry for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteDomainRequest

func (c *Lightsail) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput)

DeleteDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDomain for more information on using the DeleteDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDomainRequest method.
req, resp := client.DeleteDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomain

func (*Lightsail) DeleteDomainWithContext added in v1.8.0

func (c *Lightsail) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error)

DeleteDomainWithContext is the same as DeleteDomain with the addition of the ability to pass a context and additional request options.

See DeleteDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteInstance

func (c *Lightsail) DeleteInstance(input *DeleteInstanceInput) (*DeleteInstanceOutput, error)

DeleteInstance API operation for Amazon Lightsail.

Deletes a specific Amazon Lightsail virtual private server, or instance.

The delete instance operation 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstance

func (*Lightsail) DeleteInstanceRequest

func (c *Lightsail) DeleteInstanceRequest(input *DeleteInstanceInput) (req *request.Request, output *DeleteInstanceOutput)

DeleteInstanceRequest generates a "aws/request.Request" representing the client's request for the DeleteInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteInstance for more information on using the DeleteInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteInstanceRequest method.
req, resp := client.DeleteInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstance

func (*Lightsail) DeleteInstanceSnapshot

func (c *Lightsail) DeleteInstanceSnapshot(input *DeleteInstanceSnapshotInput) (*DeleteInstanceSnapshotOutput, error)

DeleteInstanceSnapshot API operation for Amazon Lightsail.

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 instanceSnapshotName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteInstanceSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceSnapshot

func (*Lightsail) DeleteInstanceSnapshotRequest

func (c *Lightsail) DeleteInstanceSnapshotRequest(input *DeleteInstanceSnapshotInput) (req *request.Request, output *DeleteInstanceSnapshotOutput)

DeleteInstanceSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteInstanceSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteInstanceSnapshot for more information on using the DeleteInstanceSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteInstanceSnapshotRequest method.
req, resp := client.DeleteInstanceSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceSnapshot

func (*Lightsail) DeleteInstanceSnapshotWithContext added in v1.8.0

func (c *Lightsail) DeleteInstanceSnapshotWithContext(ctx aws.Context, input *DeleteInstanceSnapshotInput, opts ...request.Option) (*DeleteInstanceSnapshotOutput, error)

DeleteInstanceSnapshotWithContext is the same as DeleteInstanceSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteInstanceSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteInstanceWithContext added in v1.8.0

func (c *Lightsail) DeleteInstanceWithContext(ctx aws.Context, input *DeleteInstanceInput, opts ...request.Option) (*DeleteInstanceOutput, error)

DeleteInstanceWithContext is the same as DeleteInstance with the addition of the ability to pass a context and additional request options.

See DeleteInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteKeyPair

func (c *Lightsail) DeleteKeyPair(input *DeleteKeyPairInput) (*DeleteKeyPairOutput, error)

DeleteKeyPair API operation for Amazon Lightsail.

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 keyPairName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKeyPair

func (*Lightsail) DeleteKeyPairRequest

func (c *Lightsail) DeleteKeyPairRequest(input *DeleteKeyPairInput) (req *request.Request, output *DeleteKeyPairOutput)

DeleteKeyPairRequest generates a "aws/request.Request" representing the client's request for the DeleteKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteKeyPair for more information on using the DeleteKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteKeyPairRequest method.
req, resp := client.DeleteKeyPairRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKeyPair

func (*Lightsail) DeleteKeyPairWithContext added in v1.8.0

func (c *Lightsail) DeleteKeyPairWithContext(ctx aws.Context, input *DeleteKeyPairInput, opts ...request.Option) (*DeleteKeyPairOutput, error)

DeleteKeyPairWithContext is the same as DeleteKeyPair with the addition of the ability to pass a context and additional request options.

See DeleteKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteKnownHostKeys added in v1.99.0

func (c *Lightsail) DeleteKnownHostKeys(input *DeleteKnownHostKeysInput) (*DeleteKnownHostKeysOutput, error)

DeleteKnownHostKeys API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteKnownHostKeys for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKnownHostKeys

func (*Lightsail) DeleteKnownHostKeysRequest added in v1.99.0

func (c *Lightsail) DeleteKnownHostKeysRequest(input *DeleteKnownHostKeysInput) (req *request.Request, output *DeleteKnownHostKeysOutput)

DeleteKnownHostKeysRequest generates a "aws/request.Request" representing the client's request for the DeleteKnownHostKeys operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteKnownHostKeys for more information on using the DeleteKnownHostKeys API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteKnownHostKeysRequest method.
req, resp := client.DeleteKnownHostKeysRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKnownHostKeys

func (*Lightsail) DeleteKnownHostKeysWithContext added in v1.99.0

func (c *Lightsail) DeleteKnownHostKeysWithContext(ctx aws.Context, input *DeleteKnownHostKeysInput, opts ...request.Option) (*DeleteKnownHostKeysOutput, error)

DeleteKnownHostKeysWithContext is the same as DeleteKnownHostKeys with the addition of the ability to pass a context and additional request options.

See DeleteKnownHostKeys for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteLoadBalancer added in v1.12.37

func (c *Lightsail) DeleteLoadBalancer(input *DeleteLoadBalancerInput) (*DeleteLoadBalancerOutput, error)

DeleteLoadBalancer API operation for Amazon Lightsail.

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 loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancer

func (*Lightsail) DeleteLoadBalancerRequest added in v1.12.37

func (c *Lightsail) DeleteLoadBalancerRequest(input *DeleteLoadBalancerInput) (req *request.Request, output *DeleteLoadBalancerOutput)

DeleteLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the DeleteLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLoadBalancer for more information on using the DeleteLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLoadBalancerRequest method.
req, resp := client.DeleteLoadBalancerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancer

func (*Lightsail) DeleteLoadBalancerTlsCertificate added in v1.12.37

func (c *Lightsail) DeleteLoadBalancerTlsCertificate(input *DeleteLoadBalancerTlsCertificateInput) (*DeleteLoadBalancerTlsCertificateOutput, error)

DeleteLoadBalancerTlsCertificate API operation for Amazon Lightsail.

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteLoadBalancerTlsCertificate for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate

func (*Lightsail) DeleteLoadBalancerTlsCertificateRequest added in v1.12.37

func (c *Lightsail) DeleteLoadBalancerTlsCertificateRequest(input *DeleteLoadBalancerTlsCertificateInput) (req *request.Request, output *DeleteLoadBalancerTlsCertificateOutput)

DeleteLoadBalancerTlsCertificateRequest generates a "aws/request.Request" representing the client's request for the DeleteLoadBalancerTlsCertificate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLoadBalancerTlsCertificate for more information on using the DeleteLoadBalancerTlsCertificate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLoadBalancerTlsCertificateRequest method.
req, resp := client.DeleteLoadBalancerTlsCertificateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate

func (*Lightsail) DeleteLoadBalancerTlsCertificateWithContext added in v1.12.37

func (c *Lightsail) DeleteLoadBalancerTlsCertificateWithContext(ctx aws.Context, input *DeleteLoadBalancerTlsCertificateInput, opts ...request.Option) (*DeleteLoadBalancerTlsCertificateOutput, error)

DeleteLoadBalancerTlsCertificateWithContext is the same as DeleteLoadBalancerTlsCertificate with the addition of the ability to pass a context and additional request options.

See DeleteLoadBalancerTlsCertificate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteLoadBalancerWithContext added in v1.12.37

func (c *Lightsail) DeleteLoadBalancerWithContext(ctx aws.Context, input *DeleteLoadBalancerInput, opts ...request.Option) (*DeleteLoadBalancerOutput, error)

DeleteLoadBalancerWithContext is the same as DeleteLoadBalancer with the addition of the ability to pass a context and additional request options.

See DeleteLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteRelationalDatabase added in v1.99.0

func (c *Lightsail) DeleteRelationalDatabase(input *DeleteRelationalDatabaseInput) (*DeleteRelationalDatabaseOutput, error)

DeleteRelationalDatabase API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabase

func (*Lightsail) DeleteRelationalDatabaseRequest added in v1.99.0

func (c *Lightsail) DeleteRelationalDatabaseRequest(input *DeleteRelationalDatabaseInput) (req *request.Request, output *DeleteRelationalDatabaseOutput)

DeleteRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the DeleteRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRelationalDatabase for more information on using the DeleteRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRelationalDatabaseRequest method.
req, resp := client.DeleteRelationalDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabase

func (*Lightsail) DeleteRelationalDatabaseSnapshot added in v1.99.0

func (c *Lightsail) DeleteRelationalDatabaseSnapshot(input *DeleteRelationalDatabaseSnapshotInput) (*DeleteRelationalDatabaseSnapshotOutput, error)

DeleteRelationalDatabaseSnapshot API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DeleteRelationalDatabaseSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot

func (*Lightsail) DeleteRelationalDatabaseSnapshotRequest added in v1.99.0

func (c *Lightsail) DeleteRelationalDatabaseSnapshotRequest(input *DeleteRelationalDatabaseSnapshotInput) (req *request.Request, output *DeleteRelationalDatabaseSnapshotOutput)

DeleteRelationalDatabaseSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteRelationalDatabaseSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRelationalDatabaseSnapshot for more information on using the DeleteRelationalDatabaseSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRelationalDatabaseSnapshotRequest method.
req, resp := client.DeleteRelationalDatabaseSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot

func (*Lightsail) DeleteRelationalDatabaseSnapshotWithContext added in v1.99.0

func (c *Lightsail) DeleteRelationalDatabaseSnapshotWithContext(ctx aws.Context, input *DeleteRelationalDatabaseSnapshotInput, opts ...request.Option) (*DeleteRelationalDatabaseSnapshotOutput, error)

DeleteRelationalDatabaseSnapshotWithContext is the same as DeleteRelationalDatabaseSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteRelationalDatabaseSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DeleteRelationalDatabaseWithContext added in v1.99.0

func (c *Lightsail) DeleteRelationalDatabaseWithContext(ctx aws.Context, input *DeleteRelationalDatabaseInput, opts ...request.Option) (*DeleteRelationalDatabaseOutput, error)

DeleteRelationalDatabaseWithContext is the same as DeleteRelationalDatabase with the addition of the ability to pass a context and additional request options.

See DeleteRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DetachDisk added in v1.12.27

func (c *Lightsail) DetachDisk(input *DetachDiskInput) (*DetachDiskOutput, error)

DetachDisk API operation for Amazon Lightsail.

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 diskName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DetachDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachDisk

func (*Lightsail) DetachDiskRequest added in v1.12.27

func (c *Lightsail) DetachDiskRequest(input *DetachDiskInput) (req *request.Request, output *DetachDiskOutput)

DetachDiskRequest generates a "aws/request.Request" representing the client's request for the DetachDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachDisk for more information on using the DetachDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachDiskRequest method.
req, resp := client.DetachDiskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachDisk

func (*Lightsail) DetachDiskWithContext added in v1.12.27

func (c *Lightsail) DetachDiskWithContext(ctx aws.Context, input *DetachDiskInput, opts ...request.Option) (*DetachDiskOutput, error)

DetachDiskWithContext is the same as DetachDisk with the addition of the ability to pass a context and additional request options.

See DetachDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DetachInstancesFromLoadBalancer added in v1.12.37

func (c *Lightsail) DetachInstancesFromLoadBalancer(input *DetachInstancesFromLoadBalancerInput) (*DetachInstancesFromLoadBalancerOutput, error)

DetachInstancesFromLoadBalancer API operation for Amazon Lightsail.

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 loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DetachInstancesFromLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancer

func (*Lightsail) DetachInstancesFromLoadBalancerRequest added in v1.12.37

func (c *Lightsail) DetachInstancesFromLoadBalancerRequest(input *DetachInstancesFromLoadBalancerInput) (req *request.Request, output *DetachInstancesFromLoadBalancerOutput)

DetachInstancesFromLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the DetachInstancesFromLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachInstancesFromLoadBalancer for more information on using the DetachInstancesFromLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachInstancesFromLoadBalancerRequest method.
req, resp := client.DetachInstancesFromLoadBalancerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancer

func (*Lightsail) DetachInstancesFromLoadBalancerWithContext added in v1.12.37

func (c *Lightsail) DetachInstancesFromLoadBalancerWithContext(ctx aws.Context, input *DetachInstancesFromLoadBalancerInput, opts ...request.Option) (*DetachInstancesFromLoadBalancerOutput, error)

DetachInstancesFromLoadBalancerWithContext is the same as DetachInstancesFromLoadBalancer with the addition of the ability to pass a context and additional request options.

See DetachInstancesFromLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DetachStaticIp

func (c *Lightsail) DetachStaticIp(input *DetachStaticIpInput) (*DetachStaticIpOutput, error)

DetachStaticIp API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DetachStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachStaticIp

func (*Lightsail) DetachStaticIpRequest

func (c *Lightsail) DetachStaticIpRequest(input *DetachStaticIpInput) (req *request.Request, output *DetachStaticIpOutput)

DetachStaticIpRequest generates a "aws/request.Request" representing the client's request for the DetachStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachStaticIp for more information on using the DetachStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachStaticIpRequest method.
req, resp := client.DetachStaticIpRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachStaticIp

func (*Lightsail) DetachStaticIpWithContext added in v1.8.0

func (c *Lightsail) DetachStaticIpWithContext(ctx aws.Context, input *DetachStaticIpInput, opts ...request.Option) (*DetachStaticIpOutput, error)

DetachStaticIpWithContext is the same as DetachStaticIp with the addition of the ability to pass a context and additional request options.

See DetachStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) DownloadDefaultKeyPair

func (c *Lightsail) DownloadDefaultKeyPair(input *DownloadDefaultKeyPairInput) (*DownloadDefaultKeyPairOutput, error)

DownloadDefaultKeyPair API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation DownloadDefaultKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DownloadDefaultKeyPair

func (*Lightsail) DownloadDefaultKeyPairRequest

func (c *Lightsail) DownloadDefaultKeyPairRequest(input *DownloadDefaultKeyPairInput) (req *request.Request, output *DownloadDefaultKeyPairOutput)

DownloadDefaultKeyPairRequest generates a "aws/request.Request" representing the client's request for the DownloadDefaultKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DownloadDefaultKeyPair for more information on using the DownloadDefaultKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DownloadDefaultKeyPairRequest method.
req, resp := client.DownloadDefaultKeyPairRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DownloadDefaultKeyPair

func (*Lightsail) DownloadDefaultKeyPairWithContext added in v1.8.0

func (c *Lightsail) DownloadDefaultKeyPairWithContext(ctx aws.Context, input *DownloadDefaultKeyPairInput, opts ...request.Option) (*DownloadDefaultKeyPairOutput, error)

DownloadDefaultKeyPairWithContext is the same as DownloadDefaultKeyPair with the addition of the ability to pass a context and additional request options.

See DownloadDefaultKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) ExportSnapshot added in v1.99.0

func (c *Lightsail) ExportSnapshot(input *ExportSnapshotInput) (*ExportSnapshotOutput, error)

ExportSnapshot API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation ExportSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshot

func (*Lightsail) ExportSnapshotRequest added in v1.99.0

func (c *Lightsail) ExportSnapshotRequest(input *ExportSnapshotInput) (req *request.Request, output *ExportSnapshotOutput)

ExportSnapshotRequest generates a "aws/request.Request" representing the client's request for the ExportSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExportSnapshot for more information on using the ExportSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ExportSnapshotRequest method.
req, resp := client.ExportSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshot

func (*Lightsail) ExportSnapshotWithContext added in v1.99.0

func (c *Lightsail) ExportSnapshotWithContext(ctx aws.Context, input *ExportSnapshotInput, opts ...request.Option) (*ExportSnapshotOutput, error)

ExportSnapshotWithContext is the same as ExportSnapshot with the addition of the ability to pass a context and additional request options.

See ExportSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetActiveNames

func (c *Lightsail) GetActiveNames(input *GetActiveNamesInput) (*GetActiveNamesOutput, error)

GetActiveNames API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetActiveNames for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetActiveNames

func (*Lightsail) GetActiveNamesRequest

func (c *Lightsail) GetActiveNamesRequest(input *GetActiveNamesInput) (req *request.Request, output *GetActiveNamesOutput)

GetActiveNamesRequest generates a "aws/request.Request" representing the client's request for the GetActiveNames operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetActiveNames for more information on using the GetActiveNames API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetActiveNamesRequest method.
req, resp := client.GetActiveNamesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetActiveNames

func (*Lightsail) GetActiveNamesWithContext added in v1.8.0

func (c *Lightsail) GetActiveNamesWithContext(ctx aws.Context, input *GetActiveNamesInput, opts ...request.Option) (*GetActiveNamesOutput, error)

GetActiveNamesWithContext is the same as GetActiveNames with the addition of the ability to pass a context and additional request options.

See GetActiveNames for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetBlueprints

func (c *Lightsail) GetBlueprints(input *GetBlueprintsInput) (*GetBlueprintsOutput, error)

GetBlueprints API operation for Amazon Lightsail.

Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetBlueprints for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprints

func (*Lightsail) GetBlueprintsRequest

func (c *Lightsail) GetBlueprintsRequest(input *GetBlueprintsInput) (req *request.Request, output *GetBlueprintsOutput)

GetBlueprintsRequest generates a "aws/request.Request" representing the client's request for the GetBlueprints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBlueprints for more information on using the GetBlueprints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBlueprintsRequest method.
req, resp := client.GetBlueprintsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprints

func (*Lightsail) GetBlueprintsWithContext added in v1.8.0

func (c *Lightsail) GetBlueprintsWithContext(ctx aws.Context, input *GetBlueprintsInput, opts ...request.Option) (*GetBlueprintsOutput, error)

GetBlueprintsWithContext is the same as GetBlueprints with the addition of the ability to pass a context and additional request options.

See GetBlueprints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetBundles

func (c *Lightsail) GetBundles(input *GetBundlesInput) (*GetBundlesOutput, error)

GetBundles API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetBundles for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundles

func (*Lightsail) GetBundlesRequest

func (c *Lightsail) GetBundlesRequest(input *GetBundlesInput) (req *request.Request, output *GetBundlesOutput)

GetBundlesRequest generates a "aws/request.Request" representing the client's request for the GetBundles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBundles for more information on using the GetBundles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBundlesRequest method.
req, resp := client.GetBundlesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundles

func (*Lightsail) GetBundlesWithContext added in v1.8.0

func (c *Lightsail) GetBundlesWithContext(ctx aws.Context, input *GetBundlesInput, opts ...request.Option) (*GetBundlesOutput, error)

GetBundlesWithContext is the same as GetBundles with the addition of the ability to pass a context and additional request options.

See GetBundles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetCloudFormationStackRecords added in v1.99.0

func (c *Lightsail) GetCloudFormationStackRecords(input *GetCloudFormationStackRecordsInput) (*GetCloudFormationStackRecordsOutput, error)

GetCloudFormationStackRecords API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetCloudFormationStackRecords for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecords

func (*Lightsail) GetCloudFormationStackRecordsRequest added in v1.99.0

func (c *Lightsail) GetCloudFormationStackRecordsRequest(input *GetCloudFormationStackRecordsInput) (req *request.Request, output *GetCloudFormationStackRecordsOutput)

GetCloudFormationStackRecordsRequest generates a "aws/request.Request" representing the client's request for the GetCloudFormationStackRecords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCloudFormationStackRecords for more information on using the GetCloudFormationStackRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCloudFormationStackRecordsRequest method.
req, resp := client.GetCloudFormationStackRecordsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecords

func (*Lightsail) GetCloudFormationStackRecordsWithContext added in v1.99.0

func (c *Lightsail) GetCloudFormationStackRecordsWithContext(ctx aws.Context, input *GetCloudFormationStackRecordsInput, opts ...request.Option) (*GetCloudFormationStackRecordsOutput, error)

GetCloudFormationStackRecordsWithContext is the same as GetCloudFormationStackRecords with the addition of the ability to pass a context and additional request options.

See GetCloudFormationStackRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetDisk added in v1.12.27

func (c *Lightsail) GetDisk(input *GetDiskInput) (*GetDiskOutput, error)

GetDisk API operation for Amazon Lightsail.

Returns information about a specific block storage disk.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDisk for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisk

func (*Lightsail) GetDiskRequest added in v1.12.27

func (c *Lightsail) GetDiskRequest(input *GetDiskInput) (req *request.Request, output *GetDiskOutput)

GetDiskRequest generates a "aws/request.Request" representing the client's request for the GetDisk operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDisk for more information on using the GetDisk API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDiskRequest method.
req, resp := client.GetDiskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisk

func (*Lightsail) GetDiskSnapshot added in v1.12.27

func (c *Lightsail) GetDiskSnapshot(input *GetDiskSnapshotInput) (*GetDiskSnapshotOutput, error)

GetDiskSnapshot API operation for Amazon Lightsail.

Returns information about a specific block storage disk snapshot.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDiskSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshot

func (*Lightsail) GetDiskSnapshotRequest added in v1.12.27

func (c *Lightsail) GetDiskSnapshotRequest(input *GetDiskSnapshotInput) (req *request.Request, output *GetDiskSnapshotOutput)

GetDiskSnapshotRequest generates a "aws/request.Request" representing the client's request for the GetDiskSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDiskSnapshot for more information on using the GetDiskSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDiskSnapshotRequest method.
req, resp := client.GetDiskSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshot

func (*Lightsail) GetDiskSnapshotWithContext added in v1.12.27

func (c *Lightsail) GetDiskSnapshotWithContext(ctx aws.Context, input *GetDiskSnapshotInput, opts ...request.Option) (*GetDiskSnapshotOutput, error)

GetDiskSnapshotWithContext is the same as GetDiskSnapshot with the addition of the ability to pass a context and additional request options.

See GetDiskSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetDiskSnapshots added in v1.12.27

func (c *Lightsail) GetDiskSnapshots(input *GetDiskSnapshotsInput) (*GetDiskSnapshotsOutput, error)

GetDiskSnapshots API operation for Amazon Lightsail.

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

If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDiskSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshots

func (*Lightsail) GetDiskSnapshotsRequest added in v1.12.27

func (c *Lightsail) GetDiskSnapshotsRequest(input *GetDiskSnapshotsInput) (req *request.Request, output *GetDiskSnapshotsOutput)

GetDiskSnapshotsRequest generates a "aws/request.Request" representing the client's request for the GetDiskSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDiskSnapshots for more information on using the GetDiskSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDiskSnapshotsRequest method.
req, resp := client.GetDiskSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshots

func (*Lightsail) GetDiskSnapshotsWithContext added in v1.12.27

func (c *Lightsail) GetDiskSnapshotsWithContext(ctx aws.Context, input *GetDiskSnapshotsInput, opts ...request.Option) (*GetDiskSnapshotsOutput, error)

GetDiskSnapshotsWithContext is the same as GetDiskSnapshots with the addition of the ability to pass a context and additional request options.

See GetDiskSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetDiskWithContext added in v1.12.27

func (c *Lightsail) GetDiskWithContext(ctx aws.Context, input *GetDiskInput, opts ...request.Option) (*GetDiskOutput, error)

GetDiskWithContext is the same as GetDisk with the addition of the ability to pass a context and additional request options.

See GetDisk for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetDisks added in v1.12.27

func (c *Lightsail) GetDisks(input *GetDisksInput) (*GetDisksOutput, error)

GetDisks API operation for Amazon Lightsail.

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

If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDisks for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisks

func (*Lightsail) GetDisksRequest added in v1.12.27

func (c *Lightsail) GetDisksRequest(input *GetDisksInput) (req *request.Request, output *GetDisksOutput)

GetDisksRequest generates a "aws/request.Request" representing the client's request for the GetDisks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDisks for more information on using the GetDisks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDisksRequest method.
req, resp := client.GetDisksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisks

func (*Lightsail) GetDisksWithContext added in v1.12.27

func (c *Lightsail) GetDisksWithContext(ctx aws.Context, input *GetDisksInput, opts ...request.Option) (*GetDisksOutput, error)

GetDisksWithContext is the same as GetDisks with the addition of the ability to pass a context and additional request options.

See GetDisks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetDomain

func (c *Lightsail) GetDomain(input *GetDomainInput) (*GetDomainOutput, error)

GetDomain API operation for Amazon Lightsail.

Returns information about a specific domain recordset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDomain for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomain

func (*Lightsail) GetDomainRequest

func (c *Lightsail) GetDomainRequest(input *GetDomainInput) (req *request.Request, output *GetDomainOutput)

GetDomainRequest generates a "aws/request.Request" representing the client's request for the GetDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDomain for more information on using the GetDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDomainRequest method.
req, resp := client.GetDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomain

func (*Lightsail) GetDomainWithContext added in v1.8.0

func (c *Lightsail) GetDomainWithContext(ctx aws.Context, input *GetDomainInput, opts ...request.Option) (*GetDomainOutput, error)

GetDomainWithContext is the same as GetDomain with the addition of the ability to pass a context and additional request options.

See GetDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetDomains

func (c *Lightsail) GetDomains(input *GetDomainsInput) (*GetDomainsOutput, error)

GetDomains API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetDomains for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomains

func (*Lightsail) GetDomainsRequest

func (c *Lightsail) GetDomainsRequest(input *GetDomainsInput) (req *request.Request, output *GetDomainsOutput)

GetDomainsRequest generates a "aws/request.Request" representing the client's request for the GetDomains operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDomains for more information on using the GetDomains API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDomainsRequest method.
req, resp := client.GetDomainsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomains

func (*Lightsail) GetDomainsWithContext added in v1.8.0

func (c *Lightsail) GetDomainsWithContext(ctx aws.Context, input *GetDomainsInput, opts ...request.Option) (*GetDomainsOutput, error)

GetDomainsWithContext is the same as GetDomains with the addition of the ability to pass a context and additional request options.

See GetDomains for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetExportSnapshotRecords added in v1.99.0

func (c *Lightsail) GetExportSnapshotRecords(input *GetExportSnapshotRecordsInput) (*GetExportSnapshotRecordsOutput, error)

GetExportSnapshotRecords API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetExportSnapshotRecords for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetExportSnapshotRecords

func (*Lightsail) GetExportSnapshotRecordsRequest added in v1.99.0

func (c *Lightsail) GetExportSnapshotRecordsRequest(input *GetExportSnapshotRecordsInput) (req *request.Request, output *GetExportSnapshotRecordsOutput)

GetExportSnapshotRecordsRequest generates a "aws/request.Request" representing the client's request for the GetExportSnapshotRecords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetExportSnapshotRecords for more information on using the GetExportSnapshotRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetExportSnapshotRecordsRequest method.
req, resp := client.GetExportSnapshotRecordsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetExportSnapshotRecords

func (*Lightsail) GetExportSnapshotRecordsWithContext added in v1.99.0

func (c *Lightsail) GetExportSnapshotRecordsWithContext(ctx aws.Context, input *GetExportSnapshotRecordsInput, opts ...request.Option) (*GetExportSnapshotRecordsOutput, error)

GetExportSnapshotRecordsWithContext is the same as GetExportSnapshotRecords with the addition of the ability to pass a context and additional request options.

See GetExportSnapshotRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetInstance

func (c *Lightsail) GetInstance(input *GetInstanceInput) (*GetInstanceOutput, error)

GetInstance API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstance

func (*Lightsail) GetInstanceAccessDetails

func (c *Lightsail) GetInstanceAccessDetails(input *GetInstanceAccessDetailsInput) (*GetInstanceAccessDetailsOutput, error)

GetInstanceAccessDetails API operation for Amazon Lightsail.

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 instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceAccessDetails for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceAccessDetails

func (*Lightsail) GetInstanceAccessDetailsRequest

func (c *Lightsail) GetInstanceAccessDetailsRequest(input *GetInstanceAccessDetailsInput) (req *request.Request, output *GetInstanceAccessDetailsOutput)

GetInstanceAccessDetailsRequest generates a "aws/request.Request" representing the client's request for the GetInstanceAccessDetails operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceAccessDetails for more information on using the GetInstanceAccessDetails API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceAccessDetailsRequest method.
req, resp := client.GetInstanceAccessDetailsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceAccessDetails

func (*Lightsail) GetInstanceAccessDetailsWithContext added in v1.8.0

func (c *Lightsail) GetInstanceAccessDetailsWithContext(ctx aws.Context, input *GetInstanceAccessDetailsInput, opts ...request.Option) (*GetInstanceAccessDetailsOutput, error)

GetInstanceAccessDetailsWithContext is the same as GetInstanceAccessDetails with the addition of the ability to pass a context and additional request options.

See GetInstanceAccessDetails for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetInstanceMetricData

func (c *Lightsail) GetInstanceMetricData(input *GetInstanceMetricDataInput) (*GetInstanceMetricDataOutput, error)

GetInstanceMetricData API operation for Amazon Lightsail.

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricData

func (*Lightsail) GetInstanceMetricDataRequest

func (c *Lightsail) GetInstanceMetricDataRequest(input *GetInstanceMetricDataInput) (req *request.Request, output *GetInstanceMetricDataOutput)

GetInstanceMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetInstanceMetricData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceMetricData for more information on using the GetInstanceMetricData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceMetricDataRequest method.
req, resp := client.GetInstanceMetricDataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricData

func (*Lightsail) GetInstanceMetricDataWithContext added in v1.8.0

func (c *Lightsail) GetInstanceMetricDataWithContext(ctx aws.Context, input *GetInstanceMetricDataInput, opts ...request.Option) (*GetInstanceMetricDataOutput, error)

GetInstanceMetricDataWithContext is the same as GetInstanceMetricData with the addition of the ability to pass a context and additional request options.

See GetInstanceMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetInstancePortStates

func (c *Lightsail) GetInstancePortStates(input *GetInstancePortStatesInput) (*GetInstancePortStatesOutput, error)

GetInstancePortStates API operation for Amazon Lightsail.

Returns the port states for a specific virtual private server, or instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstancePortStates for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStates

func (*Lightsail) GetInstancePortStatesRequest

func (c *Lightsail) GetInstancePortStatesRequest(input *GetInstancePortStatesInput) (req *request.Request, output *GetInstancePortStatesOutput)

GetInstancePortStatesRequest generates a "aws/request.Request" representing the client's request for the GetInstancePortStates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstancePortStates for more information on using the GetInstancePortStates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstancePortStatesRequest method.
req, resp := client.GetInstancePortStatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStates

func (*Lightsail) GetInstancePortStatesWithContext added in v1.8.0

func (c *Lightsail) GetInstancePortStatesWithContext(ctx aws.Context, input *GetInstancePortStatesInput, opts ...request.Option) (*GetInstancePortStatesOutput, error)

GetInstancePortStatesWithContext is the same as GetInstancePortStates with the addition of the ability to pass a context and additional request options.

See GetInstancePortStates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetInstanceRequest

func (c *Lightsail) GetInstanceRequest(input *GetInstanceInput) (req *request.Request, output *GetInstanceOutput)

GetInstanceRequest generates a "aws/request.Request" representing the client's request for the GetInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstance for more information on using the GetInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceRequest method.
req, resp := client.GetInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstance

func (*Lightsail) GetInstanceSnapshot

func (c *Lightsail) GetInstanceSnapshot(input *GetInstanceSnapshotInput) (*GetInstanceSnapshotOutput, error)

GetInstanceSnapshot API operation for Amazon Lightsail.

Returns information about a specific instance snapshot.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshot

func (*Lightsail) GetInstanceSnapshotRequest

func (c *Lightsail) GetInstanceSnapshotRequest(input *GetInstanceSnapshotInput) (req *request.Request, output *GetInstanceSnapshotOutput)

GetInstanceSnapshotRequest generates a "aws/request.Request" representing the client's request for the GetInstanceSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceSnapshot for more information on using the GetInstanceSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceSnapshotRequest method.
req, resp := client.GetInstanceSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshot

func (*Lightsail) GetInstanceSnapshotWithContext added in v1.8.0

func (c *Lightsail) GetInstanceSnapshotWithContext(ctx aws.Context, input *GetInstanceSnapshotInput, opts ...request.Option) (*GetInstanceSnapshotOutput, error)

GetInstanceSnapshotWithContext is the same as GetInstanceSnapshot with the addition of the ability to pass a context and additional request options.

See GetInstanceSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetInstanceSnapshots

func (c *Lightsail) GetInstanceSnapshots(input *GetInstanceSnapshotsInput) (*GetInstanceSnapshotsOutput, error)

GetInstanceSnapshots API operation for Amazon Lightsail.

Returns all instance snapshots for the user's account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshots

func (*Lightsail) GetInstanceSnapshotsRequest

func (c *Lightsail) GetInstanceSnapshotsRequest(input *GetInstanceSnapshotsInput) (req *request.Request, output *GetInstanceSnapshotsOutput)

GetInstanceSnapshotsRequest generates a "aws/request.Request" representing the client's request for the GetInstanceSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceSnapshots for more information on using the GetInstanceSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceSnapshotsRequest method.
req, resp := client.GetInstanceSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshots

func (*Lightsail) GetInstanceSnapshotsWithContext added in v1.8.0

func (c *Lightsail) GetInstanceSnapshotsWithContext(ctx aws.Context, input *GetInstanceSnapshotsInput, opts ...request.Option) (*GetInstanceSnapshotsOutput, error)

GetInstanceSnapshotsWithContext is the same as GetInstanceSnapshots with the addition of the ability to pass a context and additional request options.

See GetInstanceSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetInstanceState

func (c *Lightsail) GetInstanceState(input *GetInstanceStateInput) (*GetInstanceStateOutput, error)

GetInstanceState API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstanceState for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceState

func (*Lightsail) GetInstanceStateRequest

func (c *Lightsail) GetInstanceStateRequest(input *GetInstanceStateInput) (req *request.Request, output *GetInstanceStateOutput)

GetInstanceStateRequest generates a "aws/request.Request" representing the client's request for the GetInstanceState operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstanceState for more information on using the GetInstanceState API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceStateRequest method.
req, resp := client.GetInstanceStateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceState

func (*Lightsail) GetInstanceStateWithContext added in v1.8.0

func (c *Lightsail) GetInstanceStateWithContext(ctx aws.Context, input *GetInstanceStateInput, opts ...request.Option) (*GetInstanceStateOutput, error)

GetInstanceStateWithContext is the same as GetInstanceState with the addition of the ability to pass a context and additional request options.

See GetInstanceState for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetInstanceWithContext added in v1.8.0

func (c *Lightsail) GetInstanceWithContext(ctx aws.Context, input *GetInstanceInput, opts ...request.Option) (*GetInstanceOutput, error)

GetInstanceWithContext is the same as GetInstance with the addition of the ability to pass a context and additional request options.

See GetInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetInstances

func (c *Lightsail) GetInstances(input *GetInstancesInput) (*GetInstancesOutput, error)

GetInstances API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetInstances for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstances

func (*Lightsail) GetInstancesRequest

func (c *Lightsail) GetInstancesRequest(input *GetInstancesInput) (req *request.Request, output *GetInstancesOutput)

GetInstancesRequest generates a "aws/request.Request" representing the client's request for the GetInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstances for more information on using the GetInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstancesRequest method.
req, resp := client.GetInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstances

func (*Lightsail) GetInstancesWithContext added in v1.8.0

func (c *Lightsail) GetInstancesWithContext(ctx aws.Context, input *GetInstancesInput, opts ...request.Option) (*GetInstancesOutput, error)

GetInstancesWithContext is the same as GetInstances with the addition of the ability to pass a context and additional request options.

See GetInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetKeyPair

func (c *Lightsail) GetKeyPair(input *GetKeyPairInput) (*GetKeyPairOutput, error)

GetKeyPair API operation for Amazon Lightsail.

Returns information about a specific key pair.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPair

func (*Lightsail) GetKeyPairRequest

func (c *Lightsail) GetKeyPairRequest(input *GetKeyPairInput) (req *request.Request, output *GetKeyPairOutput)

GetKeyPairRequest generates a "aws/request.Request" representing the client's request for the GetKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKeyPair for more information on using the GetKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetKeyPairRequest method.
req, resp := client.GetKeyPairRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPair

func (*Lightsail) GetKeyPairWithContext added in v1.8.0

func (c *Lightsail) GetKeyPairWithContext(ctx aws.Context, input *GetKeyPairInput, opts ...request.Option) (*GetKeyPairOutput, error)

GetKeyPairWithContext is the same as GetKeyPair with the addition of the ability to pass a context and additional request options.

See GetKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetKeyPairs

func (c *Lightsail) GetKeyPairs(input *GetKeyPairsInput) (*GetKeyPairsOutput, error)

GetKeyPairs API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetKeyPairs for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairs

func (*Lightsail) GetKeyPairsRequest

func (c *Lightsail) GetKeyPairsRequest(input *GetKeyPairsInput) (req *request.Request, output *GetKeyPairsOutput)

GetKeyPairsRequest generates a "aws/request.Request" representing the client's request for the GetKeyPairs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKeyPairs for more information on using the GetKeyPairs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetKeyPairsRequest method.
req, resp := client.GetKeyPairsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairs

func (*Lightsail) GetKeyPairsWithContext added in v1.8.0

func (c *Lightsail) GetKeyPairsWithContext(ctx aws.Context, input *GetKeyPairsInput, opts ...request.Option) (*GetKeyPairsOutput, error)

GetKeyPairsWithContext is the same as GetKeyPairs with the addition of the ability to pass a context and additional request options.

See GetKeyPairs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetLoadBalancer added in v1.12.37

func (c *Lightsail) GetLoadBalancer(input *GetLoadBalancerInput) (*GetLoadBalancerOutput, error)

GetLoadBalancer API operation for Amazon Lightsail.

Returns information about the specified Lightsail load balancer.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetLoadBalancer for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancer

func (*Lightsail) GetLoadBalancerMetricData added in v1.12.37

func (c *Lightsail) GetLoadBalancerMetricData(input *GetLoadBalancerMetricDataInput) (*GetLoadBalancerMetricDataOutput, error)

GetLoadBalancerMetricData API operation for Amazon Lightsail.

Returns information about health metrics for your Lightsail load balancer.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetLoadBalancerMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricData

func (*Lightsail) GetLoadBalancerMetricDataRequest added in v1.12.37

func (c *Lightsail) GetLoadBalancerMetricDataRequest(input *GetLoadBalancerMetricDataInput) (req *request.Request, output *GetLoadBalancerMetricDataOutput)

GetLoadBalancerMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancerMetricData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoadBalancerMetricData for more information on using the GetLoadBalancerMetricData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoadBalancerMetricDataRequest method.
req, resp := client.GetLoadBalancerMetricDataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricData

func (*Lightsail) GetLoadBalancerMetricDataWithContext added in v1.12.37

func (c *Lightsail) GetLoadBalancerMetricDataWithContext(ctx aws.Context, input *GetLoadBalancerMetricDataInput, opts ...request.Option) (*GetLoadBalancerMetricDataOutput, error)

GetLoadBalancerMetricDataWithContext is the same as GetLoadBalancerMetricData with the addition of the ability to pass a context and additional request options.

See GetLoadBalancerMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetLoadBalancerRequest added in v1.12.37

func (c *Lightsail) GetLoadBalancerRequest(input *GetLoadBalancerInput) (req *request.Request, output *GetLoadBalancerOutput)

GetLoadBalancerRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoadBalancer for more information on using the GetLoadBalancer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoadBalancerRequest method.
req, resp := client.GetLoadBalancerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancer

func (*Lightsail) GetLoadBalancerTlsCertificates added in v1.12.37

func (c *Lightsail) GetLoadBalancerTlsCertificates(input *GetLoadBalancerTlsCertificatesInput) (*GetLoadBalancerTlsCertificatesOutput, error)

GetLoadBalancerTlsCertificates API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetLoadBalancerTlsCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsCertificates

func (*Lightsail) GetLoadBalancerTlsCertificatesRequest added in v1.12.37

func (c *Lightsail) GetLoadBalancerTlsCertificatesRequest(input *GetLoadBalancerTlsCertificatesInput) (req *request.Request, output *GetLoadBalancerTlsCertificatesOutput)

GetLoadBalancerTlsCertificatesRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancerTlsCertificates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoadBalancerTlsCertificates for more information on using the GetLoadBalancerTlsCertificates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoadBalancerTlsCertificatesRequest method.
req, resp := client.GetLoadBalancerTlsCertificatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsCertificates

func (*Lightsail) GetLoadBalancerTlsCertificatesWithContext added in v1.12.37

func (c *Lightsail) GetLoadBalancerTlsCertificatesWithContext(ctx aws.Context, input *GetLoadBalancerTlsCertificatesInput, opts ...request.Option) (*GetLoadBalancerTlsCertificatesOutput, error)

GetLoadBalancerTlsCertificatesWithContext is the same as GetLoadBalancerTlsCertificates with the addition of the ability to pass a context and additional request options.

See GetLoadBalancerTlsCertificates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetLoadBalancerWithContext added in v1.12.37

func (c *Lightsail) GetLoadBalancerWithContext(ctx aws.Context, input *GetLoadBalancerInput, opts ...request.Option) (*GetLoadBalancerOutput, error)

GetLoadBalancerWithContext is the same as GetLoadBalancer with the addition of the ability to pass a context and additional request options.

See GetLoadBalancer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetLoadBalancers added in v1.12.37

func (c *Lightsail) GetLoadBalancers(input *GetLoadBalancersInput) (*GetLoadBalancersOutput, error)

GetLoadBalancers API operation for Amazon Lightsail.

Returns information about all load balancers in an account.

If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetLoadBalancers for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancers

func (*Lightsail) GetLoadBalancersRequest added in v1.12.37

func (c *Lightsail) GetLoadBalancersRequest(input *GetLoadBalancersInput) (req *request.Request, output *GetLoadBalancersOutput)

GetLoadBalancersRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLoadBalancers for more information on using the GetLoadBalancers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLoadBalancersRequest method.
req, resp := client.GetLoadBalancersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancers

func (*Lightsail) GetLoadBalancersWithContext added in v1.12.37

func (c *Lightsail) GetLoadBalancersWithContext(ctx aws.Context, input *GetLoadBalancersInput, opts ...request.Option) (*GetLoadBalancersOutput, error)

GetLoadBalancersWithContext is the same as GetLoadBalancers with the addition of the ability to pass a context and additional request options.

See GetLoadBalancers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetOperation

func (c *Lightsail) GetOperation(input *GetOperationInput) (*GetOperationOutput, error)

GetOperation API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetOperation for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperation

func (*Lightsail) GetOperationRequest

func (c *Lightsail) GetOperationRequest(input *GetOperationInput) (req *request.Request, output *GetOperationOutput)

GetOperationRequest generates a "aws/request.Request" representing the client's request for the GetOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOperation for more information on using the GetOperation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOperationRequest method.
req, resp := client.GetOperationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperation

func (*Lightsail) GetOperationWithContext added in v1.8.0

func (c *Lightsail) GetOperationWithContext(ctx aws.Context, input *GetOperationInput, opts ...request.Option) (*GetOperationOutput, error)

GetOperationWithContext is the same as GetOperation with the addition of the ability to pass a context and additional request options.

See GetOperation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetOperations

func (c *Lightsail) GetOperations(input *GetOperationsInput) (*GetOperationsOutput, error)

GetOperations API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetOperations for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperations

func (*Lightsail) GetOperationsForResource

func (c *Lightsail) GetOperationsForResource(input *GetOperationsForResourceInput) (*GetOperationsForResourceOutput, error)

GetOperationsForResource API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetOperationsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResource

func (*Lightsail) GetOperationsForResourceRequest

func (c *Lightsail) GetOperationsForResourceRequest(input *GetOperationsForResourceInput) (req *request.Request, output *GetOperationsForResourceOutput)

GetOperationsForResourceRequest generates a "aws/request.Request" representing the client's request for the GetOperationsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOperationsForResource for more information on using the GetOperationsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOperationsForResourceRequest method.
req, resp := client.GetOperationsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResource

func (*Lightsail) GetOperationsForResourceWithContext added in v1.8.0

func (c *Lightsail) GetOperationsForResourceWithContext(ctx aws.Context, input *GetOperationsForResourceInput, opts ...request.Option) (*GetOperationsForResourceOutput, error)

GetOperationsForResourceWithContext is the same as GetOperationsForResource with the addition of the ability to pass a context and additional request options.

See GetOperationsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetOperationsRequest

func (c *Lightsail) GetOperationsRequest(input *GetOperationsInput) (req *request.Request, output *GetOperationsOutput)

GetOperationsRequest generates a "aws/request.Request" representing the client's request for the GetOperations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOperations for more information on using the GetOperations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOperationsRequest method.
req, resp := client.GetOperationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperations

func (*Lightsail) GetOperationsWithContext added in v1.8.0

func (c *Lightsail) GetOperationsWithContext(ctx aws.Context, input *GetOperationsInput, opts ...request.Option) (*GetOperationsOutput, error)

GetOperationsWithContext is the same as GetOperations with the addition of the ability to pass a context and additional request options.

See GetOperations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRegions

func (c *Lightsail) GetRegions(input *GetRegionsInput) (*GetRegionsOutput, error)

GetRegions API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRegions for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRegions

func (*Lightsail) GetRegionsRequest

func (c *Lightsail) GetRegionsRequest(input *GetRegionsInput) (req *request.Request, output *GetRegionsOutput)

GetRegionsRequest generates a "aws/request.Request" representing the client's request for the GetRegions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRegions for more information on using the GetRegions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRegionsRequest method.
req, resp := client.GetRegionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRegions

func (*Lightsail) GetRegionsWithContext added in v1.8.0

func (c *Lightsail) GetRegionsWithContext(ctx aws.Context, input *GetRegionsInput, opts ...request.Option) (*GetRegionsOutput, error)

GetRegionsWithContext is the same as GetRegions with the addition of the ability to pass a context and additional request options.

See GetRegions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabase added in v1.99.0

func (c *Lightsail) GetRelationalDatabase(input *GetRelationalDatabaseInput) (*GetRelationalDatabaseOutput, error)

GetRelationalDatabase API operation for Amazon Lightsail.

Returns information about a specific database in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabase

func (*Lightsail) GetRelationalDatabaseBlueprints added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseBlueprints(input *GetRelationalDatabaseBlueprintsInput) (*GetRelationalDatabaseBlueprintsOutput, error)

GetRelationalDatabaseBlueprints API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseBlueprints for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprints

func (*Lightsail) GetRelationalDatabaseBlueprintsRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseBlueprintsRequest(input *GetRelationalDatabaseBlueprintsInput) (req *request.Request, output *GetRelationalDatabaseBlueprintsOutput)

GetRelationalDatabaseBlueprintsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseBlueprints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseBlueprints for more information on using the GetRelationalDatabaseBlueprints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseBlueprintsRequest method.
req, resp := client.GetRelationalDatabaseBlueprintsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprints

func (*Lightsail) GetRelationalDatabaseBlueprintsWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseBlueprintsWithContext(ctx aws.Context, input *GetRelationalDatabaseBlueprintsInput, opts ...request.Option) (*GetRelationalDatabaseBlueprintsOutput, error)

GetRelationalDatabaseBlueprintsWithContext is the same as GetRelationalDatabaseBlueprints with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseBlueprints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseBundles added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseBundles(input *GetRelationalDatabaseBundlesInput) (*GetRelationalDatabaseBundlesOutput, error)

GetRelationalDatabaseBundles API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseBundles for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundles

func (*Lightsail) GetRelationalDatabaseBundlesRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseBundlesRequest(input *GetRelationalDatabaseBundlesInput) (req *request.Request, output *GetRelationalDatabaseBundlesOutput)

GetRelationalDatabaseBundlesRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseBundles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseBundles for more information on using the GetRelationalDatabaseBundles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseBundlesRequest method.
req, resp := client.GetRelationalDatabaseBundlesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundles

func (*Lightsail) GetRelationalDatabaseBundlesWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseBundlesWithContext(ctx aws.Context, input *GetRelationalDatabaseBundlesInput, opts ...request.Option) (*GetRelationalDatabaseBundlesOutput, error)

GetRelationalDatabaseBundlesWithContext is the same as GetRelationalDatabaseBundles with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseBundles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseEvents added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseEvents(input *GetRelationalDatabaseEventsInput) (*GetRelationalDatabaseEventsOutput, error)

GetRelationalDatabaseEvents API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseEvents for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEvents

func (*Lightsail) GetRelationalDatabaseEventsRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseEventsRequest(input *GetRelationalDatabaseEventsInput) (req *request.Request, output *GetRelationalDatabaseEventsOutput)

GetRelationalDatabaseEventsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseEvents for more information on using the GetRelationalDatabaseEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseEventsRequest method.
req, resp := client.GetRelationalDatabaseEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEvents

func (*Lightsail) GetRelationalDatabaseEventsWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseEventsWithContext(ctx aws.Context, input *GetRelationalDatabaseEventsInput, opts ...request.Option) (*GetRelationalDatabaseEventsOutput, error)

GetRelationalDatabaseEventsWithContext is the same as GetRelationalDatabaseEvents with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseLogEvents added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseLogEvents(input *GetRelationalDatabaseLogEventsInput) (*GetRelationalDatabaseLogEventsOutput, error)

GetRelationalDatabaseLogEvents API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseLogEvents for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEvents

func (*Lightsail) GetRelationalDatabaseLogEventsRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseLogEventsRequest(input *GetRelationalDatabaseLogEventsInput) (req *request.Request, output *GetRelationalDatabaseLogEventsOutput)

GetRelationalDatabaseLogEventsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseLogEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseLogEvents for more information on using the GetRelationalDatabaseLogEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseLogEventsRequest method.
req, resp := client.GetRelationalDatabaseLogEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEvents

func (*Lightsail) GetRelationalDatabaseLogEventsWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseLogEventsWithContext(ctx aws.Context, input *GetRelationalDatabaseLogEventsInput, opts ...request.Option) (*GetRelationalDatabaseLogEventsOutput, error)

GetRelationalDatabaseLogEventsWithContext is the same as GetRelationalDatabaseLogEvents with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseLogEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseLogStreams added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseLogStreams(input *GetRelationalDatabaseLogStreamsInput) (*GetRelationalDatabaseLogStreamsOutput, error)

GetRelationalDatabaseLogStreams API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseLogStreams for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogStreams

func (*Lightsail) GetRelationalDatabaseLogStreamsRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseLogStreamsRequest(input *GetRelationalDatabaseLogStreamsInput) (req *request.Request, output *GetRelationalDatabaseLogStreamsOutput)

GetRelationalDatabaseLogStreamsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseLogStreams operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseLogStreams for more information on using the GetRelationalDatabaseLogStreams API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseLogStreamsRequest method.
req, resp := client.GetRelationalDatabaseLogStreamsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogStreams

func (*Lightsail) GetRelationalDatabaseLogStreamsWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseLogStreamsWithContext(ctx aws.Context, input *GetRelationalDatabaseLogStreamsInput, opts ...request.Option) (*GetRelationalDatabaseLogStreamsOutput, error)

GetRelationalDatabaseLogStreamsWithContext is the same as GetRelationalDatabaseLogStreams with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseLogStreams for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseMasterUserPassword added in v1.99.0

GetRelationalDatabaseMasterUserPassword API operation for Amazon Lightsail.

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The asdf operation GetRelationalDatabaseMasterUserPassword supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseMasterUserPassword for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword

func (*Lightsail) GetRelationalDatabaseMasterUserPasswordRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseMasterUserPasswordRequest(input *GetRelationalDatabaseMasterUserPasswordInput) (req *request.Request, output *GetRelationalDatabaseMasterUserPasswordOutput)

GetRelationalDatabaseMasterUserPasswordRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseMasterUserPassword operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseMasterUserPassword for more information on using the GetRelationalDatabaseMasterUserPassword API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseMasterUserPasswordRequest method.
req, resp := client.GetRelationalDatabaseMasterUserPasswordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword

func (*Lightsail) GetRelationalDatabaseMasterUserPasswordWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseMasterUserPasswordWithContext(ctx aws.Context, input *GetRelationalDatabaseMasterUserPasswordInput, opts ...request.Option) (*GetRelationalDatabaseMasterUserPasswordOutput, error)

GetRelationalDatabaseMasterUserPasswordWithContext is the same as GetRelationalDatabaseMasterUserPassword with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseMasterUserPassword for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseMetricData added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseMetricData(input *GetRelationalDatabaseMetricDataInput) (*GetRelationalDatabaseMetricDataOutput, error)

GetRelationalDatabaseMetricData API operation for Amazon Lightsail.

Returns the data points of the specified metric for a database in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricData

func (*Lightsail) GetRelationalDatabaseMetricDataRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseMetricDataRequest(input *GetRelationalDatabaseMetricDataInput) (req *request.Request, output *GetRelationalDatabaseMetricDataOutput)

GetRelationalDatabaseMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseMetricData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseMetricData for more information on using the GetRelationalDatabaseMetricData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseMetricDataRequest method.
req, resp := client.GetRelationalDatabaseMetricDataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricData

func (*Lightsail) GetRelationalDatabaseMetricDataWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseMetricDataWithContext(ctx aws.Context, input *GetRelationalDatabaseMetricDataInput, opts ...request.Option) (*GetRelationalDatabaseMetricDataOutput, error)

GetRelationalDatabaseMetricDataWithContext is the same as GetRelationalDatabaseMetricData with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseMetricData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseParameters added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseParameters(input *GetRelationalDatabaseParametersInput) (*GetRelationalDatabaseParametersOutput, error)

GetRelationalDatabaseParameters API operation for Amazon Lightsail.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseParameters for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParameters

func (*Lightsail) GetRelationalDatabaseParametersRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseParametersRequest(input *GetRelationalDatabaseParametersInput) (req *request.Request, output *GetRelationalDatabaseParametersOutput)

GetRelationalDatabaseParametersRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseParameters for more information on using the GetRelationalDatabaseParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseParametersRequest method.
req, resp := client.GetRelationalDatabaseParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParameters

func (*Lightsail) GetRelationalDatabaseParametersWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseParametersWithContext(ctx aws.Context, input *GetRelationalDatabaseParametersInput, opts ...request.Option) (*GetRelationalDatabaseParametersOutput, error)

GetRelationalDatabaseParametersWithContext is the same as GetRelationalDatabaseParameters with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseRequest(input *GetRelationalDatabaseInput) (req *request.Request, output *GetRelationalDatabaseOutput)

GetRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabase for more information on using the GetRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseRequest method.
req, resp := client.GetRelationalDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabase

func (*Lightsail) GetRelationalDatabaseSnapshot added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseSnapshot(input *GetRelationalDatabaseSnapshotInput) (*GetRelationalDatabaseSnapshotOutput, error)

GetRelationalDatabaseSnapshot API operation for Amazon Lightsail.

Returns information about a specific database snapshot in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshot

func (*Lightsail) GetRelationalDatabaseSnapshotRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseSnapshotRequest(input *GetRelationalDatabaseSnapshotInput) (req *request.Request, output *GetRelationalDatabaseSnapshotOutput)

GetRelationalDatabaseSnapshotRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseSnapshot for more information on using the GetRelationalDatabaseSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseSnapshotRequest method.
req, resp := client.GetRelationalDatabaseSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshot

func (*Lightsail) GetRelationalDatabaseSnapshotWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseSnapshotWithContext(ctx aws.Context, input *GetRelationalDatabaseSnapshotInput, opts ...request.Option) (*GetRelationalDatabaseSnapshotOutput, error)

GetRelationalDatabaseSnapshotWithContext is the same as GetRelationalDatabaseSnapshot with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseSnapshots added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseSnapshots(input *GetRelationalDatabaseSnapshotsInput) (*GetRelationalDatabaseSnapshotsOutput, error)

GetRelationalDatabaseSnapshots API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabaseSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshots

func (*Lightsail) GetRelationalDatabaseSnapshotsRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseSnapshotsRequest(input *GetRelationalDatabaseSnapshotsInput) (req *request.Request, output *GetRelationalDatabaseSnapshotsOutput)

GetRelationalDatabaseSnapshotsRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabaseSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabaseSnapshots for more information on using the GetRelationalDatabaseSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabaseSnapshotsRequest method.
req, resp := client.GetRelationalDatabaseSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshots

func (*Lightsail) GetRelationalDatabaseSnapshotsWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseSnapshotsWithContext(ctx aws.Context, input *GetRelationalDatabaseSnapshotsInput, opts ...request.Option) (*GetRelationalDatabaseSnapshotsOutput, error)

GetRelationalDatabaseSnapshotsWithContext is the same as GetRelationalDatabaseSnapshots with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabaseSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabaseWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabaseWithContext(ctx aws.Context, input *GetRelationalDatabaseInput, opts ...request.Option) (*GetRelationalDatabaseOutput, error)

GetRelationalDatabaseWithContext is the same as GetRelationalDatabase with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetRelationalDatabases added in v1.99.0

func (c *Lightsail) GetRelationalDatabases(input *GetRelationalDatabasesInput) (*GetRelationalDatabasesOutput, error)

GetRelationalDatabases API operation for Amazon Lightsail.

Returns information about all of your databases in Amazon Lightsail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetRelationalDatabases for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabases

func (*Lightsail) GetRelationalDatabasesRequest added in v1.99.0

func (c *Lightsail) GetRelationalDatabasesRequest(input *GetRelationalDatabasesInput) (req *request.Request, output *GetRelationalDatabasesOutput)

GetRelationalDatabasesRequest generates a "aws/request.Request" representing the client's request for the GetRelationalDatabases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRelationalDatabases for more information on using the GetRelationalDatabases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRelationalDatabasesRequest method.
req, resp := client.GetRelationalDatabasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabases

func (*Lightsail) GetRelationalDatabasesWithContext added in v1.99.0

func (c *Lightsail) GetRelationalDatabasesWithContext(ctx aws.Context, input *GetRelationalDatabasesInput, opts ...request.Option) (*GetRelationalDatabasesOutput, error)

GetRelationalDatabasesWithContext is the same as GetRelationalDatabases with the addition of the ability to pass a context and additional request options.

See GetRelationalDatabases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetStaticIp

func (c *Lightsail) GetStaticIp(input *GetStaticIpInput) (*GetStaticIpOutput, error)

GetStaticIp API operation for Amazon Lightsail.

Returns information about a specific static IP.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIp

func (*Lightsail) GetStaticIpRequest

func (c *Lightsail) GetStaticIpRequest(input *GetStaticIpInput) (req *request.Request, output *GetStaticIpOutput)

GetStaticIpRequest generates a "aws/request.Request" representing the client's request for the GetStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetStaticIp for more information on using the GetStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetStaticIpRequest method.
req, resp := client.GetStaticIpRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIp

func (*Lightsail) GetStaticIpWithContext added in v1.8.0

func (c *Lightsail) GetStaticIpWithContext(ctx aws.Context, input *GetStaticIpInput, opts ...request.Option) (*GetStaticIpOutput, error)

GetStaticIpWithContext is the same as GetStaticIp with the addition of the ability to pass a context and additional request options.

See GetStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) GetStaticIps

func (c *Lightsail) GetStaticIps(input *GetStaticIpsInput) (*GetStaticIpsOutput, error)

GetStaticIps API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation GetStaticIps for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIps

func (*Lightsail) GetStaticIpsRequest

func (c *Lightsail) GetStaticIpsRequest(input *GetStaticIpsInput) (req *request.Request, output *GetStaticIpsOutput)

GetStaticIpsRequest generates a "aws/request.Request" representing the client's request for the GetStaticIps operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetStaticIps for more information on using the GetStaticIps API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetStaticIpsRequest method.
req, resp := client.GetStaticIpsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIps

func (*Lightsail) GetStaticIpsWithContext added in v1.8.0

func (c *Lightsail) GetStaticIpsWithContext(ctx aws.Context, input *GetStaticIpsInput, opts ...request.Option) (*GetStaticIpsOutput, error)

GetStaticIpsWithContext is the same as GetStaticIps with the addition of the ability to pass a context and additional request options.

See GetStaticIps for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) ImportKeyPair

func (c *Lightsail) ImportKeyPair(input *ImportKeyPairInput) (*ImportKeyPairOutput, error)

ImportKeyPair API operation for Amazon Lightsail.

Imports a public SSH key from a specific key pair.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation ImportKeyPair for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPair

func (*Lightsail) ImportKeyPairRequest

func (c *Lightsail) ImportKeyPairRequest(input *ImportKeyPairInput) (req *request.Request, output *ImportKeyPairOutput)

ImportKeyPairRequest generates a "aws/request.Request" representing the client's request for the ImportKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportKeyPair for more information on using the ImportKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ImportKeyPairRequest method.
req, resp := client.ImportKeyPairRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPair

func (*Lightsail) ImportKeyPairWithContext added in v1.8.0

func (c *Lightsail) ImportKeyPairWithContext(ctx aws.Context, input *ImportKeyPairInput, opts ...request.Option) (*ImportKeyPairOutput, error)

ImportKeyPairWithContext is the same as ImportKeyPair with the addition of the ability to pass a context and additional request options.

See ImportKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) IsVpcPeered

func (c *Lightsail) IsVpcPeered(input *IsVpcPeeredInput) (*IsVpcPeeredOutput, error)

IsVpcPeered API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation IsVpcPeered for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeered

func (*Lightsail) IsVpcPeeredRequest

func (c *Lightsail) IsVpcPeeredRequest(input *IsVpcPeeredInput) (req *request.Request, output *IsVpcPeeredOutput)

IsVpcPeeredRequest generates a "aws/request.Request" representing the client's request for the IsVpcPeered operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IsVpcPeered for more information on using the IsVpcPeered API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the IsVpcPeeredRequest method.
req, resp := client.IsVpcPeeredRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeered

func (*Lightsail) IsVpcPeeredWithContext added in v1.8.0

func (c *Lightsail) IsVpcPeeredWithContext(ctx aws.Context, input *IsVpcPeeredInput, opts ...request.Option) (*IsVpcPeeredOutput, error)

IsVpcPeeredWithContext is the same as IsVpcPeered with the addition of the ability to pass a context and additional request options.

See IsVpcPeered for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) OpenInstancePublicPorts

func (c *Lightsail) OpenInstancePublicPorts(input *OpenInstancePublicPortsInput) (*OpenInstancePublicPortsOutput, error)

OpenInstancePublicPorts API operation for Amazon Lightsail.

Adds public ports to an Amazon Lightsail instance.

The open instance public ports operation 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation OpenInstancePublicPorts for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPorts

func (*Lightsail) OpenInstancePublicPortsRequest

func (c *Lightsail) OpenInstancePublicPortsRequest(input *OpenInstancePublicPortsInput) (req *request.Request, output *OpenInstancePublicPortsOutput)

OpenInstancePublicPortsRequest generates a "aws/request.Request" representing the client's request for the OpenInstancePublicPorts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See OpenInstancePublicPorts for more information on using the OpenInstancePublicPorts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the OpenInstancePublicPortsRequest method.
req, resp := client.OpenInstancePublicPortsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPorts

func (*Lightsail) OpenInstancePublicPortsWithContext added in v1.8.0

func (c *Lightsail) OpenInstancePublicPortsWithContext(ctx aws.Context, input *OpenInstancePublicPortsInput, opts ...request.Option) (*OpenInstancePublicPortsOutput, error)

OpenInstancePublicPortsWithContext is the same as OpenInstancePublicPorts with the addition of the ability to pass a context and additional request options.

See OpenInstancePublicPorts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) PeerVpc

func (c *Lightsail) PeerVpc(input *PeerVpcInput) (*PeerVpcOutput, error)

PeerVpc API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation PeerVpc for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpc

func (*Lightsail) PeerVpcRequest

func (c *Lightsail) PeerVpcRequest(input *PeerVpcInput) (req *request.Request, output *PeerVpcOutput)

PeerVpcRequest generates a "aws/request.Request" representing the client's request for the PeerVpc operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PeerVpc for more information on using the PeerVpc API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PeerVpcRequest method.
req, resp := client.PeerVpcRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpc

func (*Lightsail) PeerVpcWithContext added in v1.8.0

func (c *Lightsail) PeerVpcWithContext(ctx aws.Context, input *PeerVpcInput, opts ...request.Option) (*PeerVpcOutput, error)

PeerVpcWithContext is the same as PeerVpc with the addition of the ability to pass a context and additional request options.

See PeerVpc for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) PutInstancePublicPorts added in v1.8.26

func (c *Lightsail) PutInstancePublicPorts(input *PutInstancePublicPortsInput) (*PutInstancePublicPortsOutput, error)

PutInstancePublicPorts API operation for Amazon Lightsail.

Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.

The put instance public ports operation 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation PutInstancePublicPorts for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPorts

func (*Lightsail) PutInstancePublicPortsRequest added in v1.8.26

func (c *Lightsail) PutInstancePublicPortsRequest(input *PutInstancePublicPortsInput) (req *request.Request, output *PutInstancePublicPortsOutput)

PutInstancePublicPortsRequest generates a "aws/request.Request" representing the client's request for the PutInstancePublicPorts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutInstancePublicPorts for more information on using the PutInstancePublicPorts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutInstancePublicPortsRequest method.
req, resp := client.PutInstancePublicPortsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPorts

func (*Lightsail) PutInstancePublicPortsWithContext added in v1.8.26

func (c *Lightsail) PutInstancePublicPortsWithContext(ctx aws.Context, input *PutInstancePublicPortsInput, opts ...request.Option) (*PutInstancePublicPortsOutput, error)

PutInstancePublicPortsWithContext is the same as PutInstancePublicPorts with the addition of the ability to pass a context and additional request options.

See PutInstancePublicPorts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) RebootInstance

func (c *Lightsail) RebootInstance(input *RebootInstanceInput) (*RebootInstanceOutput, error)

RebootInstance API operation for Amazon Lightsail.

Restarts a specific instance.

The reboot instance operation 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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation RebootInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstance

func (*Lightsail) RebootInstanceRequest

func (c *Lightsail) RebootInstanceRequest(input *RebootInstanceInput) (req *request.Request, output *RebootInstanceOutput)

RebootInstanceRequest generates a "aws/request.Request" representing the client's request for the RebootInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootInstance for more information on using the RebootInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootInstanceRequest method.
req, resp := client.RebootInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstance

func (*Lightsail) RebootInstanceWithContext added in v1.8.0

func (c *Lightsail) RebootInstanceWithContext(ctx aws.Context, input *RebootInstanceInput, opts ...request.Option) (*RebootInstanceOutput, error)

RebootInstanceWithContext is the same as RebootInstance with the addition of the ability to pass a context and additional request options.

See RebootInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) RebootRelationalDatabase added in v1.99.0

func (c *Lightsail) RebootRelationalDatabase(input *RebootRelationalDatabaseInput) (*RebootRelationalDatabaseOutput, error)

RebootRelationalDatabase API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation RebootRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabase

func (*Lightsail) RebootRelationalDatabaseRequest added in v1.99.0

func (c *Lightsail) RebootRelationalDatabaseRequest(input *RebootRelationalDatabaseInput) (req *request.Request, output *RebootRelationalDatabaseOutput)

RebootRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the RebootRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootRelationalDatabase for more information on using the RebootRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RebootRelationalDatabaseRequest method.
req, resp := client.RebootRelationalDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabase

func (*Lightsail) RebootRelationalDatabaseWithContext added in v1.99.0

func (c *Lightsail) RebootRelationalDatabaseWithContext(ctx aws.Context, input *RebootRelationalDatabaseInput, opts ...request.Option) (*RebootRelationalDatabaseOutput, error)

RebootRelationalDatabaseWithContext is the same as RebootRelationalDatabase with the addition of the ability to pass a context and additional request options.

See RebootRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) ReleaseStaticIp

func (c *Lightsail) ReleaseStaticIp(input *ReleaseStaticIpInput) (*ReleaseStaticIpOutput, error)

ReleaseStaticIp API operation for Amazon Lightsail.

Deletes a specific static IP from your account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation ReleaseStaticIp for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ReleaseStaticIp

func (*Lightsail) ReleaseStaticIpRequest

func (c *Lightsail) ReleaseStaticIpRequest(input *ReleaseStaticIpInput) (req *request.Request, output *ReleaseStaticIpOutput)

ReleaseStaticIpRequest generates a "aws/request.Request" representing the client's request for the ReleaseStaticIp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ReleaseStaticIp for more information on using the ReleaseStaticIp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ReleaseStaticIpRequest method.
req, resp := client.ReleaseStaticIpRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ReleaseStaticIp

func (*Lightsail) ReleaseStaticIpWithContext added in v1.8.0

func (c *Lightsail) ReleaseStaticIpWithContext(ctx aws.Context, input *ReleaseStaticIpInput, opts ...request.Option) (*ReleaseStaticIpOutput, error)

ReleaseStaticIpWithContext is the same as ReleaseStaticIp with the addition of the ability to pass a context and additional request options.

See ReleaseStaticIp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) StartInstance

func (c *Lightsail) StartInstance(input *StartInstanceInput) (*StartInstanceOutput, error)

StartInstance API operation for Amazon Lightsail.

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 instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation StartInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartInstance

func (*Lightsail) StartInstanceRequest

func (c *Lightsail) StartInstanceRequest(input *StartInstanceInput) (req *request.Request, output *StartInstanceOutput)

StartInstanceRequest generates a "aws/request.Request" representing the client's request for the StartInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartInstance for more information on using the StartInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartInstanceRequest method.
req, resp := client.StartInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartInstance

func (*Lightsail) StartInstanceWithContext added in v1.8.0

func (c *Lightsail) StartInstanceWithContext(ctx aws.Context, input *StartInstanceInput, opts ...request.Option) (*StartInstanceOutput, error)

StartInstanceWithContext is the same as StartInstance with the addition of the ability to pass a context and additional request options.

See StartInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) StartRelationalDatabase added in v1.99.0

func (c *Lightsail) StartRelationalDatabase(input *StartRelationalDatabaseInput) (*StartRelationalDatabaseOutput, error)

StartRelationalDatabase API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation StartRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartRelationalDatabase

func (*Lightsail) StartRelationalDatabaseRequest added in v1.99.0

func (c *Lightsail) StartRelationalDatabaseRequest(input *StartRelationalDatabaseInput) (req *request.Request, output *StartRelationalDatabaseOutput)

StartRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the StartRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartRelationalDatabase for more information on using the StartRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartRelationalDatabaseRequest method.
req, resp := client.StartRelationalDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartRelationalDatabase

func (*Lightsail) StartRelationalDatabaseWithContext added in v1.99.0

func (c *Lightsail) StartRelationalDatabaseWithContext(ctx aws.Context, input *StartRelationalDatabaseInput, opts ...request.Option) (*StartRelationalDatabaseOutput, error)

StartRelationalDatabaseWithContext is the same as StartRelationalDatabase with the addition of the ability to pass a context and additional request options.

See StartRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) StopInstance

func (c *Lightsail) StopInstance(input *StopInstanceInput) (*StopInstanceOutput, error)

StopInstance API operation for Amazon Lightsail.

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 instanceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation StopInstance for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopInstance

func (*Lightsail) StopInstanceRequest

func (c *Lightsail) StopInstanceRequest(input *StopInstanceInput) (req *request.Request, output *StopInstanceOutput)

StopInstanceRequest generates a "aws/request.Request" representing the client's request for the StopInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopInstance for more information on using the StopInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopInstanceRequest method.
req, resp := client.StopInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopInstance

func (*Lightsail) StopInstanceWithContext added in v1.8.0

func (c *Lightsail) StopInstanceWithContext(ctx aws.Context, input *StopInstanceInput, opts ...request.Option) (*StopInstanceOutput, error)

StopInstanceWithContext is the same as StopInstance with the addition of the ability to pass a context and additional request options.

See StopInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) StopRelationalDatabase added in v1.99.0

func (c *Lightsail) StopRelationalDatabase(input *StopRelationalDatabaseInput) (*StopRelationalDatabaseOutput, error)

StopRelationalDatabase API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation StopRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopRelationalDatabase

func (*Lightsail) StopRelationalDatabaseRequest added in v1.99.0

func (c *Lightsail) StopRelationalDatabaseRequest(input *StopRelationalDatabaseInput) (req *request.Request, output *StopRelationalDatabaseOutput)

StopRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the StopRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopRelationalDatabase for more information on using the StopRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopRelationalDatabaseRequest method.
req, resp := client.StopRelationalDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopRelationalDatabase

func (*Lightsail) StopRelationalDatabaseWithContext added in v1.99.0

func (c *Lightsail) StopRelationalDatabaseWithContext(ctx aws.Context, input *StopRelationalDatabaseInput, opts ...request.Option) (*StopRelationalDatabaseOutput, error)

StopRelationalDatabaseWithContext is the same as StopRelationalDatabase with the addition of the ability to pass a context and additional request options.

See StopRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) TagResource added in v1.99.0

func (c *Lightsail) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Lightsail.

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 resourceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TagResource

func (*Lightsail) TagResourceRequest added in v1.99.0

func (c *Lightsail) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TagResource

func (*Lightsail) TagResourceWithContext added in v1.99.0

func (c *Lightsail) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) UnpeerVpc

func (c *Lightsail) UnpeerVpc(input *UnpeerVpcInput) (*UnpeerVpcOutput, error)

UnpeerVpc API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation UnpeerVpc for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UnpeerVpc

func (*Lightsail) UnpeerVpcRequest

func (c *Lightsail) UnpeerVpcRequest(input *UnpeerVpcInput) (req *request.Request, output *UnpeerVpcOutput)

UnpeerVpcRequest generates a "aws/request.Request" representing the client's request for the UnpeerVpc operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UnpeerVpc for more information on using the UnpeerVpc API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UnpeerVpcRequest method.
req, resp := client.UnpeerVpcRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UnpeerVpc

func (*Lightsail) UnpeerVpcWithContext added in v1.8.0

func (c *Lightsail) UnpeerVpcWithContext(ctx aws.Context, input *UnpeerVpcInput, opts ...request.Option) (*UnpeerVpcOutput, error)

UnpeerVpcWithContext is the same as UnpeerVpc with the addition of the ability to pass a context and additional request options.

See UnpeerVpc for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) UntagResource added in v1.99.0

func (c *Lightsail) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Lightsail.

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 resourceName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UntagResource

func (*Lightsail) UntagResourceRequest added in v1.99.0

func (c *Lightsail) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UntagResource

func (*Lightsail) UntagResourceWithContext added in v1.99.0

func (c *Lightsail) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) UpdateDomainEntry

func (c *Lightsail) UpdateDomainEntry(input *UpdateDomainEntryInput) (*UpdateDomainEntryOutput, error)

UpdateDomainEntry API operation for Amazon Lightsail.

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 domainName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation UpdateDomainEntry for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDomainEntry

func (*Lightsail) UpdateDomainEntryRequest

func (c *Lightsail) UpdateDomainEntryRequest(input *UpdateDomainEntryInput) (req *request.Request, output *UpdateDomainEntryOutput)

UpdateDomainEntryRequest generates a "aws/request.Request" representing the client's request for the UpdateDomainEntry operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDomainEntry for more information on using the UpdateDomainEntry API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateDomainEntryRequest method.
req, resp := client.UpdateDomainEntryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDomainEntry

func (*Lightsail) UpdateDomainEntryWithContext added in v1.8.0

func (c *Lightsail) UpdateDomainEntryWithContext(ctx aws.Context, input *UpdateDomainEntryInput, opts ...request.Option) (*UpdateDomainEntryOutput, error)

UpdateDomainEntryWithContext is the same as UpdateDomainEntry with the addition of the ability to pass a context and additional request options.

See UpdateDomainEntry for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) UpdateLoadBalancerAttribute added in v1.12.37

func (c *Lightsail) UpdateLoadBalancerAttribute(input *UpdateLoadBalancerAttributeInput) (*UpdateLoadBalancerAttributeOutput, error)

UpdateLoadBalancerAttribute API operation for Amazon Lightsail.

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 loadBalancerName. For more information, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation UpdateLoadBalancerAttribute for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateLoadBalancerAttribute

func (*Lightsail) UpdateLoadBalancerAttributeRequest added in v1.12.37

func (c *Lightsail) UpdateLoadBalancerAttributeRequest(input *UpdateLoadBalancerAttributeInput) (req *request.Request, output *UpdateLoadBalancerAttributeOutput)

UpdateLoadBalancerAttributeRequest generates a "aws/request.Request" representing the client's request for the UpdateLoadBalancerAttribute operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateLoadBalancerAttribute for more information on using the UpdateLoadBalancerAttribute API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateLoadBalancerAttributeRequest method.
req, resp := client.UpdateLoadBalancerAttributeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateLoadBalancerAttribute

func (*Lightsail) UpdateLoadBalancerAttributeWithContext added in v1.12.37

func (c *Lightsail) UpdateLoadBalancerAttributeWithContext(ctx aws.Context, input *UpdateLoadBalancerAttributeInput, opts ...request.Option) (*UpdateLoadBalancerAttributeOutput, error)

UpdateLoadBalancerAttributeWithContext is the same as UpdateLoadBalancerAttribute with the addition of the ability to pass a context and additional request options.

See UpdateLoadBalancerAttribute for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) UpdateRelationalDatabase added in v1.99.0

func (c *Lightsail) UpdateRelationalDatabase(input *UpdateRelationalDatabaseInput) (*UpdateRelationalDatabaseOutput, error)

UpdateRelationalDatabase API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation UpdateRelationalDatabase for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabase

func (*Lightsail) UpdateRelationalDatabaseParameters added in v1.99.0

func (c *Lightsail) UpdateRelationalDatabaseParameters(input *UpdateRelationalDatabaseParametersInput) (*UpdateRelationalDatabaseParametersOutput, error)

UpdateRelationalDatabaseParameters API operation for Amazon Lightsail.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Lightsail's API operation UpdateRelationalDatabaseParameters for usage and error information.

Returned Error Codes:

  • ErrCodeServiceException "ServiceException" A general service exception.

  • ErrCodeInvalidInputException "InvalidInputException" Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

  • ErrCodeNotFoundException "NotFoundException" Lightsail throws this exception when it cannot find a resource.

  • ErrCodeOperationFailureException "OperationFailureException" Lightsail throws this exception when an operation fails to execute.

  • ErrCodeAccessDeniedException "AccessDeniedException" Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • ErrCodeAccountSetupInProgressException "AccountSetupInProgressException" Lightsail throws this exception when an account is still in the setup in progress state.

  • ErrCodeUnauthenticatedException "UnauthenticatedException" Lightsail throws this exception when the user has not been authenticated.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseParameters

func (*Lightsail) UpdateRelationalDatabaseParametersRequest added in v1.99.0

func (c *Lightsail) UpdateRelationalDatabaseParametersRequest(input *UpdateRelationalDatabaseParametersInput) (req *request.Request, output *UpdateRelationalDatabaseParametersOutput)

UpdateRelationalDatabaseParametersRequest generates a "aws/request.Request" representing the client's request for the UpdateRelationalDatabaseParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRelationalDatabaseParameters for more information on using the UpdateRelationalDatabaseParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRelationalDatabaseParametersRequest method.
req, resp := client.UpdateRelationalDatabaseParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseParameters

func (*Lightsail) UpdateRelationalDatabaseParametersWithContext added in v1.99.0

func (c *Lightsail) UpdateRelationalDatabaseParametersWithContext(ctx aws.Context, input *UpdateRelationalDatabaseParametersInput, opts ...request.Option) (*UpdateRelationalDatabaseParametersOutput, error)

UpdateRelationalDatabaseParametersWithContext is the same as UpdateRelationalDatabaseParameters with the addition of the ability to pass a context and additional request options.

See UpdateRelationalDatabaseParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Lightsail) UpdateRelationalDatabaseRequest added in v1.99.0

func (c *Lightsail) UpdateRelationalDatabaseRequest(input *UpdateRelationalDatabaseInput) (req *request.Request, output *UpdateRelationalDatabaseOutput)

UpdateRelationalDatabaseRequest generates a "aws/request.Request" representing the client's request for the UpdateRelationalDatabase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRelationalDatabase for more information on using the UpdateRelationalDatabase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRelationalDatabaseRequest method.
req, resp := client.UpdateRelationalDatabaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabase

func (*Lightsail) UpdateRelationalDatabaseWithContext added in v1.99.0

func (c *Lightsail) UpdateRelationalDatabaseWithContext(ctx aws.Context, input *UpdateRelationalDatabaseInput, opts ...request.Option) (*UpdateRelationalDatabaseOutput, error)

UpdateRelationalDatabaseWithContext is the same as UpdateRelationalDatabase with the addition of the ability to pass a context and additional request options.

See UpdateRelationalDatabase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type LoadBalancer added in v1.12.37

type LoadBalancer struct {

	// The Amazon Resource Name (ARN) of the load balancer.
	Arn *string `locationName:"arn" type:"string"`

	// A string to string map of the configuration options for your load balancer.
	// Valid values are listed below.
	ConfigurationOptions map[string]*string `locationName:"configurationOptions" type:"map"`

	// The date when your load balancer was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The DNS name of your Lightsail load balancer.
	DnsName *string `locationName:"dnsName" type:"string"`

	// The path you specified to perform your health checks. If no path is specified,
	// the load balancer tries to make a request to the default (root) page.
	HealthCheckPath *string `locationName:"healthCheckPath" type:"string"`

	// An array of InstanceHealthSummary objects describing the health of the load
	// balancer.
	InstanceHealthSummary []*InstanceHealthSummary `locationName:"instanceHealthSummary" type:"list"`

	// The port where the load balancer will direct traffic to your Lightsail instances.
	// For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.
	InstancePort *int64 `locationName:"instancePort" type:"integer"`

	// The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail
	// automatically creates your load balancer across Availability Zones.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the load balancer (e.g., my-load-balancer).
	Name *string `locationName:"name" type:"string"`

	// The protocol you have enabled for your load balancer. Valid values are below.
	//
	// You can't just have HTTP_HTTPS, but you can have just HTTP.
	Protocol *string `locationName:"protocol" type:"string" enum:"LoadBalancerProtocol"`

	// An array of public port settings for your load balancer. For HTTP, use port
	// 80. For HTTPS, use port 443.
	PublicPorts []*int64 `locationName:"publicPorts" type:"list"`

	// The resource type (e.g., LoadBalancer.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The status of your load balancer. Valid values are below.
	State *string `locationName:"state" type:"string" enum:"LoadBalancerState"`

	// The support code. Include this code in your email to support when you have
	// questions about your Lightsail load balancer. This code enables our support
	// team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`

	// An array of LoadBalancerTlsCertificateSummary objects that provide additional
	// information about the SSL/TLS certificates. For example, if true, the certificate
	// is attached to the load balancer.
	TlsCertificateSummaries []*LoadBalancerTlsCertificateSummary `locationName:"tlsCertificateSummaries" type:"list"`
	// contains filtered or unexported fields
}

Describes the Lightsail load balancer.

func (LoadBalancer) GoString added in v1.12.37

func (s LoadBalancer) GoString() string

GoString returns the string representation

func (*LoadBalancer) SetArn added in v1.12.37

func (s *LoadBalancer) SetArn(v string) *LoadBalancer

SetArn sets the Arn field's value.

func (*LoadBalancer) SetConfigurationOptions added in v1.12.37

func (s *LoadBalancer) SetConfigurationOptions(v map[string]*string) *LoadBalancer

SetConfigurationOptions sets the ConfigurationOptions field's value.

func (*LoadBalancer) SetCreatedAt added in v1.12.37

func (s *LoadBalancer) SetCreatedAt(v time.Time) *LoadBalancer

SetCreatedAt sets the CreatedAt field's value.

func (*LoadBalancer) SetDnsName added in v1.12.37

func (s *LoadBalancer) SetDnsName(v string) *LoadBalancer

SetDnsName sets the DnsName field's value.

func (*LoadBalancer) SetHealthCheckPath added in v1.12.37

func (s *LoadBalancer) SetHealthCheckPath(v string) *LoadBalancer

SetHealthCheckPath sets the HealthCheckPath field's value.

func (*LoadBalancer) SetInstanceHealthSummary added in v1.12.37

func (s *LoadBalancer) SetInstanceHealthSummary(v []*InstanceHealthSummary) *LoadBalancer

SetInstanceHealthSummary sets the InstanceHealthSummary field's value.

func (*LoadBalancer) SetInstancePort added in v1.12.37

func (s *LoadBalancer) SetInstancePort(v int64) *LoadBalancer

SetInstancePort sets the InstancePort field's value.

func (*LoadBalancer) SetLocation added in v1.12.37

func (s *LoadBalancer) SetLocation(v *ResourceLocation) *LoadBalancer

SetLocation sets the Location field's value.

func (*LoadBalancer) SetName added in v1.12.37

func (s *LoadBalancer) SetName(v string) *LoadBalancer

SetName sets the Name field's value.

func (*LoadBalancer) SetProtocol added in v1.12.37

func (s *LoadBalancer) SetProtocol(v string) *LoadBalancer

SetProtocol sets the Protocol field's value.

func (*LoadBalancer) SetPublicPorts added in v1.12.37

func (s *LoadBalancer) SetPublicPorts(v []*int64) *LoadBalancer

SetPublicPorts sets the PublicPorts field's value.

func (*LoadBalancer) SetResourceType added in v1.12.37

func (s *LoadBalancer) SetResourceType(v string) *LoadBalancer

SetResourceType sets the ResourceType field's value.

func (*LoadBalancer) SetState added in v1.12.37

func (s *LoadBalancer) SetState(v string) *LoadBalancer

SetState sets the State field's value.

func (*LoadBalancer) SetSupportCode added in v1.12.37

func (s *LoadBalancer) SetSupportCode(v string) *LoadBalancer

SetSupportCode sets the SupportCode field's value.

func (*LoadBalancer) SetTags added in v1.99.0

func (s *LoadBalancer) SetTags(v []*Tag) *LoadBalancer

SetTags sets the Tags field's value.

func (*LoadBalancer) SetTlsCertificateSummaries added in v1.12.37

func (s *LoadBalancer) SetTlsCertificateSummaries(v []*LoadBalancerTlsCertificateSummary) *LoadBalancer

SetTlsCertificateSummaries sets the TlsCertificateSummaries field's value.

func (LoadBalancer) String added in v1.12.37

func (s LoadBalancer) String() string

String returns the string representation

type LoadBalancerTlsCertificate added in v1.12.37

type LoadBalancerTlsCertificate struct {

	// The Amazon Resource Name (ARN) of the SSL/TLS certificate.
	Arn *string `locationName:"arn" type:"string"`

	// The time when you created your SSL/TLS certificate.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The domain name for your SSL/TLS certificate.
	DomainName *string `locationName:"domainName" type:"string"`

	// An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing
	// the records.
	DomainValidationRecords []*LoadBalancerTlsCertificateDomainValidationRecord `locationName:"domainValidationRecords" type:"list"`

	// The reason for the SSL/TLS certificate validation failure.
	FailureReason *string `locationName:"failureReason" type:"string" enum:"LoadBalancerTlsCertificateFailureReason"`

	// When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
	IsAttached *bool `locationName:"isAttached" type:"boolean"`

	// The time when the SSL/TLS certificate was issued.
	IssuedAt *time.Time `locationName:"issuedAt" type:"timestamp"`

	// The issuer of the certificate.
	Issuer *string `locationName:"issuer" type:"string"`

	// The algorithm that was used to generate the key pair (the public and private
	// key).
	KeyAlgorithm *string `locationName:"keyAlgorithm" type:"string"`

	// The load balancer name where your SSL/TLS certificate is attached.
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string"`

	// The AWS Region and Availability Zone where you created your certificate.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the SSL/TLS certificate (e.g., my-certificate).
	Name *string `locationName:"name" type:"string"`

	// The timestamp when the SSL/TLS certificate expires.
	NotAfter *time.Time `locationName:"notAfter" type:"timestamp"`

	// The timestamp when the SSL/TLS certificate is first valid.
	NotBefore *time.Time `locationName:"notBefore" type:"timestamp"`

	// An object containing information about the status of Lightsail's managed
	// renewal for the certificate.
	RenewalSummary *LoadBalancerTlsCertificateRenewalSummary `locationName:"renewalSummary" type:"structure"`

	// The resource type (e.g., LoadBalancerTlsCertificate).
	//
	//    * Instance - A Lightsail instance (a virtual private server)
	//
	//    * StaticIp - A static IP address
	//
	//    * KeyPair - The key pair used to connect to a Lightsail instance
	//
	//    * InstanceSnapshot - A Lightsail instance snapshot
	//
	//    * Domain - A DNS zone
	//
	//    * PeeredVpc - A peered VPC
	//
	//    * LoadBalancer - A Lightsail load balancer
	//
	//    * LoadBalancerTlsCertificate - An SSL/TLS certificate associated with
	//    a Lightsail load balancer
	//
	//    * Disk - A Lightsail block storage disk
	//
	//    * DiskSnapshot - A block storage disk snapshot
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The reason the certificate was revoked. Valid values are below.
	RevocationReason *string `locationName:"revocationReason" type:"string" enum:"LoadBalancerTlsCertificateRevocationReason"`

	// The timestamp when the SSL/TLS certificate was revoked.
	RevokedAt *time.Time `locationName:"revokedAt" type:"timestamp"`

	// The serial number of the certificate.
	Serial *string `locationName:"serial" type:"string"`

	// The algorithm that was used to sign the certificate.
	SignatureAlgorithm *string `locationName:"signatureAlgorithm" type:"string"`

	// The status of the SSL/TLS certificate. Valid values are below.
	Status *string `locationName:"status" type:"string" enum:"LoadBalancerTlsCertificateStatus"`

	// The name of the entity that is associated with the public key contained in
	// the certificate.
	Subject *string `locationName:"subject" type:"string"`

	// One or more domains or subdomains included in the certificate. This list
	// contains the domain names that are bound to the public key that is contained
	// in the certificate. The subject alternative names include the canonical domain
	// name (CNAME) of the certificate and additional domain names that can be used
	// to connect to the website, such as example.com, www.example.com, or m.example.com.
	SubjectAlternativeNames []*string `locationName:"subjectAlternativeNames" type:"list"`

	// The support code. Include this code in your email to support when you have
	// questions about your Lightsail load balancer or SSL/TLS certificate. This
	// code enables our support team to look up your Lightsail information more
	// easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a load balancer SSL/TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

func (LoadBalancerTlsCertificate) GoString added in v1.12.37

func (s LoadBalancerTlsCertificate) GoString() string

GoString returns the string representation

func (*LoadBalancerTlsCertificate) SetArn added in v1.12.37

SetArn sets the Arn field's value.

func (*LoadBalancerTlsCertificate) SetCreatedAt added in v1.12.37

SetCreatedAt sets the CreatedAt field's value.

func (*LoadBalancerTlsCertificate) SetDomainName added in v1.12.37

SetDomainName sets the DomainName field's value.

func (*LoadBalancerTlsCertificate) SetDomainValidationRecords added in v1.12.37

SetDomainValidationRecords sets the DomainValidationRecords field's value.

func (*LoadBalancerTlsCertificate) SetFailureReason added in v1.12.37

SetFailureReason sets the FailureReason field's value.

func (*LoadBalancerTlsCertificate) SetIsAttached added in v1.12.37

SetIsAttached sets the IsAttached field's value.

func (*LoadBalancerTlsCertificate) SetIssuedAt added in v1.12.37

SetIssuedAt sets the IssuedAt field's value.

func (*LoadBalancerTlsCertificate) SetIssuer added in v1.12.37

SetIssuer sets the Issuer field's value.

func (*LoadBalancerTlsCertificate) SetKeyAlgorithm added in v1.12.37

SetKeyAlgorithm sets the KeyAlgorithm field's value.

func (*LoadBalancerTlsCertificate) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*LoadBalancerTlsCertificate) SetLocation added in v1.12.37

SetLocation sets the Location field's value.

func (*LoadBalancerTlsCertificate) SetName added in v1.12.37

SetName sets the Name field's value.

func (*LoadBalancerTlsCertificate) SetNotAfter added in v1.12.37

SetNotAfter sets the NotAfter field's value.

func (*LoadBalancerTlsCertificate) SetNotBefore added in v1.12.37

SetNotBefore sets the NotBefore field's value.

func (*LoadBalancerTlsCertificate) SetRenewalSummary added in v1.12.37

SetRenewalSummary sets the RenewalSummary field's value.

func (*LoadBalancerTlsCertificate) SetResourceType added in v1.12.37

SetResourceType sets the ResourceType field's value.

func (*LoadBalancerTlsCertificate) SetRevocationReason added in v1.12.37

SetRevocationReason sets the RevocationReason field's value.

func (*LoadBalancerTlsCertificate) SetRevokedAt added in v1.12.37

SetRevokedAt sets the RevokedAt field's value.

func (*LoadBalancerTlsCertificate) SetSerial added in v1.12.37

SetSerial sets the Serial field's value.

func (*LoadBalancerTlsCertificate) SetSignatureAlgorithm added in v1.12.37

func (s *LoadBalancerTlsCertificate) SetSignatureAlgorithm(v string) *LoadBalancerTlsCertificate

SetSignatureAlgorithm sets the SignatureAlgorithm field's value.

func (*LoadBalancerTlsCertificate) SetStatus added in v1.12.37

SetStatus sets the Status field's value.

func (*LoadBalancerTlsCertificate) SetSubject added in v1.12.37

SetSubject sets the Subject field's value.

func (*LoadBalancerTlsCertificate) SetSubjectAlternativeNames added in v1.12.37

func (s *LoadBalancerTlsCertificate) SetSubjectAlternativeNames(v []*string) *LoadBalancerTlsCertificate

SetSubjectAlternativeNames sets the SubjectAlternativeNames field's value.

func (*LoadBalancerTlsCertificate) SetSupportCode added in v1.12.37

SetSupportCode sets the SupportCode field's value.

func (*LoadBalancerTlsCertificate) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (LoadBalancerTlsCertificate) String added in v1.12.37

String returns the string representation

type LoadBalancerTlsCertificateDomainValidationOption added in v1.12.37

type LoadBalancerTlsCertificateDomainValidationOption struct {

	// The fully qualified domain name in the certificate request.
	DomainName *string `locationName:"domainName" type:"string"`

	// The status of the domain validation. Valid values are listed below.
	ValidationStatus *string `locationName:"validationStatus" type:"string" enum:"LoadBalancerTlsCertificateDomainStatus"`
	// contains filtered or unexported fields
}

Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.

func (LoadBalancerTlsCertificateDomainValidationOption) GoString added in v1.12.37

GoString returns the string representation

func (*LoadBalancerTlsCertificateDomainValidationOption) SetDomainName added in v1.12.37

SetDomainName sets the DomainName field's value.

func (*LoadBalancerTlsCertificateDomainValidationOption) SetValidationStatus added in v1.12.37

SetValidationStatus sets the ValidationStatus field's value.

func (LoadBalancerTlsCertificateDomainValidationOption) String added in v1.12.37

String returns the string representation

type LoadBalancerTlsCertificateDomainValidationRecord added in v1.12.37

type LoadBalancerTlsCertificateDomainValidationRecord struct {

	// The domain name against which your SSL/TLS certificate was validated.
	DomainName *string `locationName:"domainName" type:"string"`

	// A fully qualified domain name in the certificate. For example, example.com.
	Name *string `locationName:"name" type:"string"`

	// The type of validation record. For example, CNAME for domain validation.
	Type *string `locationName:"type" type:"string"`

	// The validation status. Valid values are listed below.
	ValidationStatus *string `locationName:"validationStatus" type:"string" enum:"LoadBalancerTlsCertificateDomainStatus"`

	// The value for that type.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Describes the validation record of each domain name in the SSL/TLS certificate.

func (LoadBalancerTlsCertificateDomainValidationRecord) GoString added in v1.12.37

GoString returns the string representation

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetDomainName added in v1.12.37

SetDomainName sets the DomainName field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetName added in v1.12.37

SetName sets the Name field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetType added in v1.12.37

SetType sets the Type field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetValidationStatus added in v1.12.37

SetValidationStatus sets the ValidationStatus field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetValue added in v1.12.37

SetValue sets the Value field's value.

func (LoadBalancerTlsCertificateDomainValidationRecord) String added in v1.12.37

String returns the string representation

type LoadBalancerTlsCertificateRenewalSummary added in v1.12.37

type LoadBalancerTlsCertificateRenewalSummary struct {

	// Contains information about the validation of each domain name in the certificate,
	// as it pertains to Lightsail's managed renewal. This is different from the
	// initial validation that occurs as a result of the RequestCertificate request.
	DomainValidationOptions []*LoadBalancerTlsCertificateDomainValidationOption `locationName:"domainValidationOptions" type:"list"`

	// The status of Lightsail's managed renewal of the certificate. Valid values
	// are listed below.
	RenewalStatus *string `locationName:"renewalStatus" type:"string" enum:"LoadBalancerTlsCertificateRenewalStatus"`
	// contains filtered or unexported fields
}

Contains information about the status of Lightsail's managed renewal for the certificate.

func (LoadBalancerTlsCertificateRenewalSummary) GoString added in v1.12.37

GoString returns the string representation

func (*LoadBalancerTlsCertificateRenewalSummary) SetDomainValidationOptions added in v1.12.37

SetDomainValidationOptions sets the DomainValidationOptions field's value.

func (*LoadBalancerTlsCertificateRenewalSummary) SetRenewalStatus added in v1.12.37

SetRenewalStatus sets the RenewalStatus field's value.

func (LoadBalancerTlsCertificateRenewalSummary) String added in v1.12.37

String returns the string representation

type LoadBalancerTlsCertificateSummary added in v1.12.37

type LoadBalancerTlsCertificateSummary struct {

	// When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
	IsAttached *bool `locationName:"isAttached" type:"boolean"`

	// The name of the SSL/TLS certificate.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Provides a summary of SSL/TLS certificate metadata.

func (LoadBalancerTlsCertificateSummary) GoString added in v1.12.37

GoString returns the string representation

func (*LoadBalancerTlsCertificateSummary) SetIsAttached added in v1.12.37

SetIsAttached sets the IsAttached field's value.

func (*LoadBalancerTlsCertificateSummary) SetName added in v1.12.37

SetName sets the Name field's value.

func (LoadBalancerTlsCertificateSummary) String added in v1.12.37

String returns the string representation

type LogEvent added in v1.99.0

type LogEvent struct {

	// The timestamp when the database log event was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The message of the database log event.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Describes a database log event.

func (LogEvent) GoString added in v1.99.0

func (s LogEvent) GoString() string

GoString returns the string representation

func (*LogEvent) SetCreatedAt added in v1.99.0

func (s *LogEvent) SetCreatedAt(v time.Time) *LogEvent

SetCreatedAt sets the CreatedAt field's value.

func (*LogEvent) SetMessage added in v1.99.0

func (s *LogEvent) SetMessage(v string) *LogEvent

SetMessage sets the Message field's value.

func (LogEvent) String added in v1.99.0

func (s LogEvent) String() string

String returns the string representation

type MetricDatapoint

type MetricDatapoint struct {

	// The average.
	Average *float64 `locationName:"average" type:"double"`

	// The maximum.
	Maximum *float64 `locationName:"maximum" type:"double"`

	// The minimum.
	Minimum *float64 `locationName:"minimum" type:"double"`

	// The sample count.
	SampleCount *float64 `locationName:"sampleCount" type:"double"`

	// The sum.
	Sum *float64 `locationName:"sum" type:"double"`

	// The timestamp (e.g., 1479816991.349).
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp"`

	// The unit.
	Unit *string `locationName:"unit" type:"string" enum:"MetricUnit"`
	// contains filtered or unexported fields
}

Describes the metric data point.

func (MetricDatapoint) GoString

func (s MetricDatapoint) GoString() string

GoString returns the string representation

func (*MetricDatapoint) SetAverage

func (s *MetricDatapoint) SetAverage(v float64) *MetricDatapoint

SetAverage sets the Average field's value.

func (*MetricDatapoint) SetMaximum

func (s *MetricDatapoint) SetMaximum(v float64) *MetricDatapoint

SetMaximum sets the Maximum field's value.

func (*MetricDatapoint) SetMinimum

func (s *MetricDatapoint) SetMinimum(v float64) *MetricDatapoint

SetMinimum sets the Minimum field's value.

func (*MetricDatapoint) SetSampleCount

func (s *MetricDatapoint) SetSampleCount(v float64) *MetricDatapoint

SetSampleCount sets the SampleCount field's value.

func (*MetricDatapoint) SetSum

func (s *MetricDatapoint) SetSum(v float64) *MetricDatapoint

SetSum sets the Sum field's value.

func (*MetricDatapoint) SetTimestamp

func (s *MetricDatapoint) SetTimestamp(v time.Time) *MetricDatapoint

SetTimestamp sets the Timestamp field's value.

func (*MetricDatapoint) SetUnit

func (s *MetricDatapoint) SetUnit(v string) *MetricDatapoint

SetUnit sets the Unit field's value.

func (MetricDatapoint) String

func (s MetricDatapoint) String() string

String returns the string representation

type MonthlyTransfer

type MonthlyTransfer struct {

	// The amount allocated per month (in GB).
	GbPerMonthAllocated *int64 `locationName:"gbPerMonthAllocated" type:"integer"`
	// contains filtered or unexported fields
}

Describes the monthly data transfer in and out of your virtual private server (or instance).

func (MonthlyTransfer) GoString

func (s MonthlyTransfer) GoString() string

GoString returns the string representation

func (*MonthlyTransfer) SetGbPerMonthAllocated

func (s *MonthlyTransfer) SetGbPerMonthAllocated(v int64) *MonthlyTransfer

SetGbPerMonthAllocated sets the GbPerMonthAllocated field's value.

func (MonthlyTransfer) String

func (s MonthlyTransfer) String() string

String returns the string representation

type OpenInstancePublicPortsInput

type OpenInstancePublicPortsInput struct {

	// The name of the instance for which you want to open the public ports.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`

	// An array of key-value pairs containing information about the port mappings.
	//
	// PortInfo is a required field
	PortInfo *PortInfo `locationName:"portInfo" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (OpenInstancePublicPortsInput) GoString

func (s OpenInstancePublicPortsInput) GoString() string

GoString returns the string representation

func (*OpenInstancePublicPortsInput) SetInstanceName

SetInstanceName sets the InstanceName field's value.

func (*OpenInstancePublicPortsInput) SetPortInfo

SetPortInfo sets the PortInfo field's value.

func (OpenInstancePublicPortsInput) String

String returns the string representation

func (*OpenInstancePublicPortsInput) Validate

func (s *OpenInstancePublicPortsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OpenInstancePublicPortsOutput

type OpenInstancePublicPortsOutput struct {

	// An array of key-value pairs containing information about the request operation.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (OpenInstancePublicPortsOutput) GoString

GoString returns the string representation

func (*OpenInstancePublicPortsOutput) SetOperation

SetOperation sets the Operation field's value.

func (OpenInstancePublicPortsOutput) String

String returns the string representation

type Operation

type Operation struct {

	// The timestamp when the operation was initialized (e.g., 1479816991.349).
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The error code.
	ErrorCode *string `locationName:"errorCode" type:"string"`

	// The error details.
	ErrorDetails *string `locationName:"errorDetails" type:"string"`

	// The ID of the operation.
	Id *string `locationName:"id" type:"string"`

	// A Boolean value indicating whether the operation is terminal.
	IsTerminal *bool `locationName:"isTerminal" type:"boolean"`

	// The region and Availability Zone.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// Details about the operation (e.g., Debian-1GB-Ohio-1).
	OperationDetails *string `locationName:"operationDetails" type:"string"`

	// The type of operation.
	OperationType *string `locationName:"operationType" type:"string" enum:"OperationType"`

	// The resource name.
	ResourceName *string `locationName:"resourceName" type:"string"`

	// The resource type.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The status of the operation.
	Status *string `locationName:"status" type:"string" enum:"OperationStatus"`

	// The timestamp when the status was changed (e.g., 1479816991.349).
	StatusChangedAt *time.Time `locationName:"statusChangedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

Describes the API operation.

func (Operation) GoString

func (s Operation) GoString() string

GoString returns the string representation

func (*Operation) SetCreatedAt

func (s *Operation) SetCreatedAt(v time.Time) *Operation

SetCreatedAt sets the CreatedAt field's value.

func (*Operation) SetErrorCode

func (s *Operation) SetErrorCode(v string) *Operation

SetErrorCode sets the ErrorCode field's value.

func (*Operation) SetErrorDetails

func (s *Operation) SetErrorDetails(v string) *Operation

SetErrorDetails sets the ErrorDetails field's value.

func (*Operation) SetId

func (s *Operation) SetId(v string) *Operation

SetId sets the Id field's value.

func (*Operation) SetIsTerminal

func (s *Operation) SetIsTerminal(v bool) *Operation

SetIsTerminal sets the IsTerminal field's value.

func (*Operation) SetLocation

func (s *Operation) SetLocation(v *ResourceLocation) *Operation

SetLocation sets the Location field's value.

func (*Operation) SetOperationDetails

func (s *Operation) SetOperationDetails(v string) *Operation

SetOperationDetails sets the OperationDetails field's value.

func (*Operation) SetOperationType

func (s *Operation) SetOperationType(v string) *Operation

SetOperationType sets the OperationType field's value.

func (*Operation) SetResourceName

func (s *Operation) SetResourceName(v string) *Operation

SetResourceName sets the ResourceName field's value.

func (*Operation) SetResourceType

func (s *Operation) SetResourceType(v string) *Operation

SetResourceType sets the ResourceType field's value.

func (*Operation) SetStatus

func (s *Operation) SetStatus(v string) *Operation

SetStatus sets the Status field's value.

func (*Operation) SetStatusChangedAt

func (s *Operation) SetStatusChangedAt(v time.Time) *Operation

SetStatusChangedAt sets the StatusChangedAt field's value.

func (Operation) String

func (s Operation) String() string

String returns the string representation

type PasswordData added in v1.12.13

type PasswordData struct {

	// The encrypted password. Ciphertext will be an empty string if access to your
	// new instance is not ready yet. When you create an instance, it can take up
	// to 15 minutes for the instance to be ready.
	//
	// If you use the default key pair (LightsailDefaultKeyPair), the decrypted
	// password will be available in the password field.
	//
	// If you are using a custom key pair, you need to use your own means of decryption.
	//
	// If you change the Administrator password on the instance, Lightsail will
	// continue to return the original ciphertext value. When accessing the instance
	// using RDP, you need to manually enter the Administrator password after changing
	// it from the default.
	Ciphertext *string `locationName:"ciphertext" type:"string"`

	// The name of the key pair that you used when creating your instance. If no
	// key pair name was specified when creating the instance, Lightsail uses the
	// default key pair (LightsailDefaultKeyPair).
	//
	// If you are using a custom key pair, you need to use your own means of decrypting
	// your password using the ciphertext. Lightsail creates the ciphertext by encrypting
	// your password with the public key part of this key pair.
	KeyPairName *string `locationName:"keyPairName" type:"string"`
	// contains filtered or unexported fields
}

The password data for the Windows Server-based instance, including the ciphertext and the key pair name.

func (PasswordData) GoString added in v1.12.13

func (s PasswordData) GoString() string

GoString returns the string representation

func (*PasswordData) SetCiphertext added in v1.12.13

func (s *PasswordData) SetCiphertext(v string) *PasswordData

SetCiphertext sets the Ciphertext field's value.

func (*PasswordData) SetKeyPairName added in v1.12.13

func (s *PasswordData) SetKeyPairName(v string) *PasswordData

SetKeyPairName sets the KeyPairName field's value.

func (PasswordData) String added in v1.12.13

func (s PasswordData) String() string

String returns the string representation

type PeerVpcInput

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

func (PeerVpcInput) GoString

func (s PeerVpcInput) GoString() string

GoString returns the string representation

func (PeerVpcInput) String

func (s PeerVpcInput) String() string

String returns the string representation

type PeerVpcOutput

type PeerVpcOutput struct {

	// An array of key-value pairs containing information about the request operation.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (PeerVpcOutput) GoString

func (s PeerVpcOutput) GoString() string

GoString returns the string representation

func (*PeerVpcOutput) SetOperation

func (s *PeerVpcOutput) SetOperation(v *Operation) *PeerVpcOutput

SetOperation sets the Operation field's value.

func (PeerVpcOutput) String

func (s PeerVpcOutput) String() string

String returns the string representation

type PendingMaintenanceAction added in v1.99.0

type PendingMaintenanceAction struct {

	// The type of pending database maintenance action.
	Action *string `locationName:"action" type:"string"`

	// The effective date of the pending database maintenance action.
	CurrentApplyDate *time.Time `locationName:"currentApplyDate" type:"timestamp"`

	// Additional detail about the pending database maintenance action.
	Description *string `locationName:"description" type:"string"`
	// contains filtered or unexported fields
}

Describes a pending database maintenance action.

func (PendingMaintenanceAction) GoString added in v1.99.0

func (s PendingMaintenanceAction) GoString() string

GoString returns the string representation

func (*PendingMaintenanceAction) SetAction added in v1.99.0

SetAction sets the Action field's value.

func (*PendingMaintenanceAction) SetCurrentApplyDate added in v1.99.0

func (s *PendingMaintenanceAction) SetCurrentApplyDate(v time.Time) *PendingMaintenanceAction

SetCurrentApplyDate sets the CurrentApplyDate field's value.

func (*PendingMaintenanceAction) SetDescription added in v1.99.0

SetDescription sets the Description field's value.

func (PendingMaintenanceAction) String added in v1.99.0

func (s PendingMaintenanceAction) String() string

String returns the string representation

type PendingModifiedRelationalDatabaseValues added in v1.99.0

type PendingModifiedRelationalDatabaseValues struct {

	// A Boolean value indicating whether automated backup retention is enabled.
	BackupRetentionEnabled *bool `locationName:"backupRetentionEnabled" type:"boolean"`

	// The database engine version.
	EngineVersion *string `locationName:"engineVersion" type:"string"`

	// The password for the master user of the database.
	MasterUserPassword *string `locationName:"masterUserPassword" type:"string"`
	// contains filtered or unexported fields
}

Describes a pending database value modification.

func (PendingModifiedRelationalDatabaseValues) GoString added in v1.99.0

GoString returns the string representation

func (*PendingModifiedRelationalDatabaseValues) SetBackupRetentionEnabled added in v1.99.0

SetBackupRetentionEnabled sets the BackupRetentionEnabled field's value.

func (*PendingModifiedRelationalDatabaseValues) SetEngineVersion added in v1.99.0

SetEngineVersion sets the EngineVersion field's value.

func (*PendingModifiedRelationalDatabaseValues) SetMasterUserPassword added in v1.99.0

SetMasterUserPassword sets the MasterUserPassword field's value.

func (PendingModifiedRelationalDatabaseValues) String added in v1.99.0

String returns the string representation

type PortInfo

type PortInfo struct {

	// The first port in the range.
	FromPort *int64 `locationName:"fromPort" type:"integer"`

	// The protocol.
	Protocol *string `locationName:"protocol" type:"string" enum:"NetworkProtocol"`

	// The last port in the range.
	ToPort *int64 `locationName:"toPort" type:"integer"`
	// contains filtered or unexported fields
}

Describes information about the ports on your virtual private server (or instance).

func (PortInfo) GoString

func (s PortInfo) GoString() string

GoString returns the string representation

func (*PortInfo) SetFromPort

func (s *PortInfo) SetFromPort(v int64) *PortInfo

SetFromPort sets the FromPort field's value.

func (*PortInfo) SetProtocol

func (s *PortInfo) SetProtocol(v string) *PortInfo

SetProtocol sets the Protocol field's value.

func (*PortInfo) SetToPort

func (s *PortInfo) SetToPort(v int64) *PortInfo

SetToPort sets the ToPort field's value.

func (PortInfo) String

func (s PortInfo) String() string

String returns the string representation

type PutInstancePublicPortsInput added in v1.8.26

type PutInstancePublicPortsInput struct {

	// The Lightsail instance name of the public port(s) you are setting.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`

	// Specifies information about the public port(s).
	//
	// PortInfos is a required field
	PortInfos []*PortInfo `locationName:"portInfos" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutInstancePublicPortsInput) GoString added in v1.8.26

func (s PutInstancePublicPortsInput) GoString() string

GoString returns the string representation

func (*PutInstancePublicPortsInput) SetInstanceName added in v1.8.26

SetInstanceName sets the InstanceName field's value.

func (*PutInstancePublicPortsInput) SetPortInfos added in v1.8.26

SetPortInfos sets the PortInfos field's value.

func (PutInstancePublicPortsInput) String added in v1.8.26

String returns the string representation

func (*PutInstancePublicPortsInput) Validate added in v1.8.26

func (s *PutInstancePublicPortsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutInstancePublicPortsOutput added in v1.8.26

type PutInstancePublicPortsOutput struct {

	// Describes metadata about the operation you just executed.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (PutInstancePublicPortsOutput) GoString added in v1.8.26

func (s PutInstancePublicPortsOutput) GoString() string

GoString returns the string representation

func (*PutInstancePublicPortsOutput) SetOperation added in v1.8.26

SetOperation sets the Operation field's value.

func (PutInstancePublicPortsOutput) String added in v1.8.26

String returns the string representation

type RebootInstanceInput

type RebootInstanceInput struct {

	// The name of the instance to reboot.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RebootInstanceInput) GoString

func (s RebootInstanceInput) GoString() string

GoString returns the string representation

func (*RebootInstanceInput) SetInstanceName

func (s *RebootInstanceInput) SetInstanceName(v string) *RebootInstanceInput

SetInstanceName sets the InstanceName field's value.

func (RebootInstanceInput) String

func (s RebootInstanceInput) String() string

String returns the string representation

func (*RebootInstanceInput) Validate

func (s *RebootInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RebootInstanceOutput

type RebootInstanceOutput struct {

	// An array of key-value pairs containing information about the request operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (RebootInstanceOutput) GoString

func (s RebootInstanceOutput) GoString() string

GoString returns the string representation

func (*RebootInstanceOutput) SetOperations

func (s *RebootInstanceOutput) SetOperations(v []*Operation) *RebootInstanceOutput

SetOperations sets the Operations field's value.

func (RebootInstanceOutput) String

func (s RebootInstanceOutput) String() string

String returns the string representation

type RebootRelationalDatabaseInput added in v1.99.0

type RebootRelationalDatabaseInput struct {

	// The name of your database to reboot.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RebootRelationalDatabaseInput) GoString added in v1.99.0

GoString returns the string representation

func (*RebootRelationalDatabaseInput) SetRelationalDatabaseName added in v1.99.0

func (s *RebootRelationalDatabaseInput) SetRelationalDatabaseName(v string) *RebootRelationalDatabaseInput

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (RebootRelationalDatabaseInput) String added in v1.99.0

String returns the string representation

func (*RebootRelationalDatabaseInput) Validate added in v1.99.0

func (s *RebootRelationalDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RebootRelationalDatabaseOutput added in v1.99.0

type RebootRelationalDatabaseOutput struct {

	// An object describing the result of your reboot relational database request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (RebootRelationalDatabaseOutput) GoString added in v1.99.0

GoString returns the string representation

func (*RebootRelationalDatabaseOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (RebootRelationalDatabaseOutput) String added in v1.99.0

String returns the string representation

type Region

type Region struct {

	// The Availability Zones. Follows the format us-east-2a (case-sensitive).
	AvailabilityZones []*AvailabilityZone `locationName:"availabilityZones" type:"list"`

	// The continent code (e.g., NA, meaning North America).
	ContinentCode *string `locationName:"continentCode" type:"string"`

	// The description of the AWS Region (e.g., This region is recommended to serve
	// users in the eastern United States and eastern Canada).
	Description *string `locationName:"description" type:"string"`

	// The display name (e.g., Ohio).
	DisplayName *string `locationName:"displayName" type:"string"`

	// The region name (e.g., us-east-2).
	Name *string `locationName:"name" type:"string" enum:"RegionName"`

	// The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).
	RelationalDatabaseAvailabilityZones []*AvailabilityZone `locationName:"relationalDatabaseAvailabilityZones" type:"list"`
	// contains filtered or unexported fields
}

Describes the AWS Region.

func (Region) GoString

func (s Region) GoString() string

GoString returns the string representation

func (*Region) SetAvailabilityZones

func (s *Region) SetAvailabilityZones(v []*AvailabilityZone) *Region

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*Region) SetContinentCode

func (s *Region) SetContinentCode(v string) *Region

SetContinentCode sets the ContinentCode field's value.

func (*Region) SetDescription

func (s *Region) SetDescription(v string) *Region

SetDescription sets the Description field's value.

func (*Region) SetDisplayName

func (s *Region) SetDisplayName(v string) *Region

SetDisplayName sets the DisplayName field's value.

func (*Region) SetName

func (s *Region) SetName(v string) *Region

SetName sets the Name field's value.

func (*Region) SetRelationalDatabaseAvailabilityZones added in v1.99.0

func (s *Region) SetRelationalDatabaseAvailabilityZones(v []*AvailabilityZone) *Region

SetRelationalDatabaseAvailabilityZones sets the RelationalDatabaseAvailabilityZones field's value.

func (Region) String

func (s Region) String() string

String returns the string representation

type RelationalDatabase added in v1.99.0

type RelationalDatabase struct {

	// The Amazon Resource Name (ARN) of the database.
	Arn *string `locationName:"arn" type:"string"`

	// A Boolean value indicating whether automated backup retention is enabled
	// for the database.
	BackupRetentionEnabled *bool `locationName:"backupRetentionEnabled" type:"boolean"`

	// The timestamp when the database was created. Formatted in Unix time.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The database software (for example, MySQL).
	Engine *string `locationName:"engine" type:"string"`

	// The database engine version (for example, 5.7.23).
	EngineVersion *string `locationName:"engineVersion" type:"string"`

	// Describes the hardware of the database.
	Hardware *RelationalDatabaseHardware `locationName:"hardware" type:"structure"`

	// The latest point in time to which the database can be restored. Formatted
	// in Unix time.
	LatestRestorableTime *time.Time `locationName:"latestRestorableTime" type:"timestamp"`

	// The Region name and Availability Zone where the database is located.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the master database created when the Lightsail database resource
	// is created.
	MasterDatabaseName *string `locationName:"masterDatabaseName" type:"string"`

	// The master endpoint for the database.
	MasterEndpoint *RelationalDatabaseEndpoint `locationName:"masterEndpoint" type:"structure"`

	// The master user name of the database.
	MasterUsername *string `locationName:"masterUsername" type:"string"`

	// The unique name of the database resource in Lightsail.
	Name *string `locationName:"name" type:"string"`

	// The status of parameter updates for the database.
	ParameterApplyStatus *string `locationName:"parameterApplyStatus" type:"string"`

	// Describes the pending maintenance actions for the database.
	PendingMaintenanceActions []*PendingMaintenanceAction `locationName:"pendingMaintenanceActions" type:"list"`

	// Describes pending database value modifications.
	PendingModifiedValues *PendingModifiedRelationalDatabaseValues `locationName:"pendingModifiedValues" type:"structure"`

	// The daily time range during which automated backups are created for the database
	// (for example, 16:00-16:30).
	PreferredBackupWindow *string `locationName:"preferredBackupWindow" type:"string"`

	// The weekly time range during which system maintenance can occur on the database.
	//
	// In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.
	PreferredMaintenanceWindow *string `locationName:"preferredMaintenanceWindow" type:"string"`

	// A Boolean value indicating whether the database is publicly accessible.
	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"`

	// The blueprint ID for the database. A blueprint describes the major engine
	// version of a database.
	RelationalDatabaseBlueprintId *string `locationName:"relationalDatabaseBlueprintId" type:"string"`

	// The bundle ID for the database. A bundle describes the performance specifications
	// for your database.
	RelationalDatabaseBundleId *string `locationName:"relationalDatabaseBundleId" type:"string"`

	// The Lightsail resource type for the database (for example, RelationalDatabase).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// Describes the secondary Availability Zone of a high availability database.
	//
	// The secondary database is used for failover support of a high availability
	// database.
	SecondaryAvailabilityZone *string `locationName:"secondaryAvailabilityZone" type:"string"`

	// Describes the current state of the database.
	State *string `locationName:"state" type:"string"`

	// The support code for the database. Include this code in your email to support
	// when you have questions about a database in Lightsail. This code enables
	// our support team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a database.

func (RelationalDatabase) GoString added in v1.99.0

func (s RelationalDatabase) GoString() string

GoString returns the string representation

func (*RelationalDatabase) SetArn added in v1.99.0

SetArn sets the Arn field's value.

func (*RelationalDatabase) SetBackupRetentionEnabled added in v1.99.0

func (s *RelationalDatabase) SetBackupRetentionEnabled(v bool) *RelationalDatabase

SetBackupRetentionEnabled sets the BackupRetentionEnabled field's value.

func (*RelationalDatabase) SetCreatedAt added in v1.99.0

func (s *RelationalDatabase) SetCreatedAt(v time.Time) *RelationalDatabase

SetCreatedAt sets the CreatedAt field's value.

func (*RelationalDatabase) SetEngine added in v1.99.0

func (s *RelationalDatabase) SetEngine(v string) *RelationalDatabase

SetEngine sets the Engine field's value.

func (*RelationalDatabase) SetEngineVersion added in v1.99.0

func (s *RelationalDatabase) SetEngineVersion(v string) *RelationalDatabase

SetEngineVersion sets the EngineVersion field's value.

func (*RelationalDatabase) SetHardware added in v1.99.0

SetHardware sets the Hardware field's value.

func (*RelationalDatabase) SetLatestRestorableTime added in v1.99.0

func (s *RelationalDatabase) SetLatestRestorableTime(v time.Time) *RelationalDatabase

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*RelationalDatabase) SetLocation added in v1.99.0

SetLocation sets the Location field's value.

func (*RelationalDatabase) SetMasterDatabaseName added in v1.99.0

func (s *RelationalDatabase) SetMasterDatabaseName(v string) *RelationalDatabase

SetMasterDatabaseName sets the MasterDatabaseName field's value.

func (*RelationalDatabase) SetMasterEndpoint added in v1.99.0

SetMasterEndpoint sets the MasterEndpoint field's value.

func (*RelationalDatabase) SetMasterUsername added in v1.99.0

func (s *RelationalDatabase) SetMasterUsername(v string) *RelationalDatabase

SetMasterUsername sets the MasterUsername field's value.

func (*RelationalDatabase) SetName added in v1.99.0

SetName sets the Name field's value.

func (*RelationalDatabase) SetParameterApplyStatus added in v1.99.0

func (s *RelationalDatabase) SetParameterApplyStatus(v string) *RelationalDatabase

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (*RelationalDatabase) SetPendingMaintenanceActions added in v1.99.0

func (s *RelationalDatabase) SetPendingMaintenanceActions(v []*PendingMaintenanceAction) *RelationalDatabase

SetPendingMaintenanceActions sets the PendingMaintenanceActions field's value.

func (*RelationalDatabase) SetPendingModifiedValues added in v1.99.0

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*RelationalDatabase) SetPreferredBackupWindow added in v1.99.0

func (s *RelationalDatabase) SetPreferredBackupWindow(v string) *RelationalDatabase

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*RelationalDatabase) SetPreferredMaintenanceWindow added in v1.99.0

func (s *RelationalDatabase) SetPreferredMaintenanceWindow(v string) *RelationalDatabase

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*RelationalDatabase) SetPubliclyAccessible added in v1.99.0

func (s *RelationalDatabase) SetPubliclyAccessible(v bool) *RelationalDatabase

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*RelationalDatabase) SetRelationalDatabaseBlueprintId added in v1.99.0

func (s *RelationalDatabase) SetRelationalDatabaseBlueprintId(v string) *RelationalDatabase

SetRelationalDatabaseBlueprintId sets the RelationalDatabaseBlueprintId field's value.

func (*RelationalDatabase) SetRelationalDatabaseBundleId added in v1.99.0

func (s *RelationalDatabase) SetRelationalDatabaseBundleId(v string) *RelationalDatabase

SetRelationalDatabaseBundleId sets the RelationalDatabaseBundleId field's value.

func (*RelationalDatabase) SetResourceType added in v1.99.0

func (s *RelationalDatabase) SetResourceType(v string) *RelationalDatabase

SetResourceType sets the ResourceType field's value.

func (*RelationalDatabase) SetSecondaryAvailabilityZone added in v1.99.0

func (s *RelationalDatabase) SetSecondaryAvailabilityZone(v string) *RelationalDatabase

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*RelationalDatabase) SetState added in v1.99.0

SetState sets the State field's value.

func (*RelationalDatabase) SetSupportCode added in v1.99.0

func (s *RelationalDatabase) SetSupportCode(v string) *RelationalDatabase

SetSupportCode sets the SupportCode field's value.

func (*RelationalDatabase) SetTags added in v1.99.0

func (s *RelationalDatabase) SetTags(v []*Tag) *RelationalDatabase

SetTags sets the Tags field's value.

func (RelationalDatabase) String added in v1.99.0

func (s RelationalDatabase) String() string

String returns the string representation

type RelationalDatabaseBlueprint added in v1.99.0

type RelationalDatabaseBlueprint struct {

	// The ID for the database blueprint.
	BlueprintId *string `locationName:"blueprintId" type:"string"`

	// The database software of the database blueprint (for example, MySQL).
	Engine *string `locationName:"engine" type:"string" enum:"RelationalDatabaseEngine"`

	// The description of the database engine for the database blueprint.
	EngineDescription *string `locationName:"engineDescription" type:"string"`

	// The database engine version for the database blueprint (for example, 5.7.23).
	EngineVersion *string `locationName:"engineVersion" type:"string"`

	// The description of the database engine version for the database blueprint.
	EngineVersionDescription *string `locationName:"engineVersionDescription" type:"string"`

	// A Boolean value indicating whether the engine version is the default for
	// the database blueprint.
	IsEngineDefault *bool `locationName:"isEngineDefault" type:"boolean"`
	// contains filtered or unexported fields
}

Describes a database image, or blueprint. A blueprint describes the major engine version of a database.

func (RelationalDatabaseBlueprint) GoString added in v1.99.0

func (s RelationalDatabaseBlueprint) GoString() string

GoString returns the string representation

func (*RelationalDatabaseBlueprint) SetBlueprintId added in v1.99.0

SetBlueprintId sets the BlueprintId field's value.

func (*RelationalDatabaseBlueprint) SetEngine added in v1.99.0

SetEngine sets the Engine field's value.

func (*RelationalDatabaseBlueprint) SetEngineDescription added in v1.99.0

SetEngineDescription sets the EngineDescription field's value.

func (*RelationalDatabaseBlueprint) SetEngineVersion added in v1.99.0

SetEngineVersion sets the EngineVersion field's value.

func (*RelationalDatabaseBlueprint) SetEngineVersionDescription added in v1.99.0

func (s *RelationalDatabaseBlueprint) SetEngineVersionDescription(v string) *RelationalDatabaseBlueprint

SetEngineVersionDescription sets the EngineVersionDescription field's value.

func (*RelationalDatabaseBlueprint) SetIsEngineDefault added in v1.99.0

SetIsEngineDefault sets the IsEngineDefault field's value.

func (RelationalDatabaseBlueprint) String added in v1.99.0

String returns the string representation

type RelationalDatabaseBundle added in v1.99.0

type RelationalDatabaseBundle struct {

	// The ID for the database bundle.
	BundleId *string `locationName:"bundleId" type:"string"`

	// The number of virtual CPUs (vCPUs) for the database bundle.
	CpuCount *int64 `locationName:"cpuCount" type:"integer"`

	// The size of the disk for the database bundle.
	DiskSizeInGb *int64 `locationName:"diskSizeInGb" type:"integer"`

	// A Boolean value indicating whether the database bundle is active.
	IsActive *bool `locationName:"isActive" type:"boolean"`

	// A Boolean value indicating whether the database bundle is encrypted.
	IsEncrypted *bool `locationName:"isEncrypted" type:"boolean"`

	// The name for the database bundle.
	Name *string `locationName:"name" type:"string"`

	// The cost of the database bundle in US currency.
	Price *float64 `locationName:"price" type:"float"`

	// The amount of RAM in GB (for example, 2.0) for the database bundle.
	RamSizeInGb *float64 `locationName:"ramSizeInGb" type:"float"`

	// The data transfer rate per month in GB for the database bundle.
	TransferPerMonthInGb *int64 `locationName:"transferPerMonthInGb" type:"integer"`
	// contains filtered or unexported fields
}

Describes a database bundle. A bundle describes the performance specifications of the database.

func (RelationalDatabaseBundle) GoString added in v1.99.0

func (s RelationalDatabaseBundle) GoString() string

GoString returns the string representation

func (*RelationalDatabaseBundle) SetBundleId added in v1.99.0

SetBundleId sets the BundleId field's value.

func (*RelationalDatabaseBundle) SetCpuCount added in v1.99.0

SetCpuCount sets the CpuCount field's value.

func (*RelationalDatabaseBundle) SetDiskSizeInGb added in v1.99.0

SetDiskSizeInGb sets the DiskSizeInGb field's value.

func (*RelationalDatabaseBundle) SetIsActive added in v1.99.0

SetIsActive sets the IsActive field's value.

func (*RelationalDatabaseBundle) SetIsEncrypted added in v1.99.0

SetIsEncrypted sets the IsEncrypted field's value.

func (*RelationalDatabaseBundle) SetName added in v1.99.0

SetName sets the Name field's value.

func (*RelationalDatabaseBundle) SetPrice added in v1.99.0

SetPrice sets the Price field's value.

func (*RelationalDatabaseBundle) SetRamSizeInGb added in v1.99.0

SetRamSizeInGb sets the RamSizeInGb field's value.

func (*RelationalDatabaseBundle) SetTransferPerMonthInGb added in v1.99.0

func (s *RelationalDatabaseBundle) SetTransferPerMonthInGb(v int64) *RelationalDatabaseBundle

SetTransferPerMonthInGb sets the TransferPerMonthInGb field's value.

func (RelationalDatabaseBundle) String added in v1.99.0

func (s RelationalDatabaseBundle) String() string

String returns the string representation

type RelationalDatabaseEndpoint added in v1.99.0

type RelationalDatabaseEndpoint struct {

	// Specifies the DNS address of the database.
	Address *string `locationName:"address" type:"string"`

	// Specifies the port that the database is listening on.
	Port *int64 `locationName:"port" type:"integer"`
	// contains filtered or unexported fields
}

Describes an endpoint for a database.

func (RelationalDatabaseEndpoint) GoString added in v1.99.0

func (s RelationalDatabaseEndpoint) GoString() string

GoString returns the string representation

func (*RelationalDatabaseEndpoint) SetAddress added in v1.99.0

SetAddress sets the Address field's value.

func (*RelationalDatabaseEndpoint) SetPort added in v1.99.0

SetPort sets the Port field's value.

func (RelationalDatabaseEndpoint) String added in v1.99.0

String returns the string representation

type RelationalDatabaseEvent added in v1.99.0

type RelationalDatabaseEvent struct {

	// The timestamp when the database event was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The category that the database event belongs to.
	EventCategories []*string `locationName:"eventCategories" type:"list"`

	// The message of the database event.
	Message *string `locationName:"message" type:"string"`

	// The database that the database event relates to.
	Resource *string `locationName:"resource" type:"string"`
	// contains filtered or unexported fields
}

Describes an event for a database.

func (RelationalDatabaseEvent) GoString added in v1.99.0

func (s RelationalDatabaseEvent) GoString() string

GoString returns the string representation

func (*RelationalDatabaseEvent) SetCreatedAt added in v1.99.0

SetCreatedAt sets the CreatedAt field's value.

func (*RelationalDatabaseEvent) SetEventCategories added in v1.99.0

func (s *RelationalDatabaseEvent) SetEventCategories(v []*string) *RelationalDatabaseEvent

SetEventCategories sets the EventCategories field's value.

func (*RelationalDatabaseEvent) SetMessage added in v1.99.0

SetMessage sets the Message field's value.

func (*RelationalDatabaseEvent) SetResource added in v1.99.0

SetResource sets the Resource field's value.

func (RelationalDatabaseEvent) String added in v1.99.0

func (s RelationalDatabaseEvent) String() string

String returns the string representation

type RelationalDatabaseHardware added in v1.99.0

type RelationalDatabaseHardware struct {

	// The number of vCPUs for the database.
	CpuCount *int64 `locationName:"cpuCount" type:"integer"`

	// The size of the disk for the database.
	DiskSizeInGb *int64 `locationName:"diskSizeInGb" type:"integer"`

	// The amount of RAM in GB for the database.
	RamSizeInGb *float64 `locationName:"ramSizeInGb" type:"float"`
	// contains filtered or unexported fields
}

Describes the hardware of a database.

func (RelationalDatabaseHardware) GoString added in v1.99.0

func (s RelationalDatabaseHardware) GoString() string

GoString returns the string representation

func (*RelationalDatabaseHardware) SetCpuCount added in v1.99.0

SetCpuCount sets the CpuCount field's value.

func (*RelationalDatabaseHardware) SetDiskSizeInGb added in v1.99.0

SetDiskSizeInGb sets the DiskSizeInGb field's value.

func (*RelationalDatabaseHardware) SetRamSizeInGb added in v1.99.0

SetRamSizeInGb sets the RamSizeInGb field's value.

func (RelationalDatabaseHardware) String added in v1.99.0

String returns the string representation

type RelationalDatabaseParameter added in v1.99.0

type RelationalDatabaseParameter struct {

	// Specifies the valid range of values for the parameter.
	AllowedValues *string `locationName:"allowedValues" type:"string"`

	// Indicates when parameter updates are applied.
	//
	// Can be immediate or pending-reboot.
	ApplyMethod *string `locationName:"applyMethod" type:"string"`

	// Specifies the engine-specific parameter type.
	ApplyType *string `locationName:"applyType" type:"string"`

	// Specifies the valid data type for the parameter.
	DataType *string `locationName:"dataType" type:"string"`

	// Provides a description of the parameter.
	Description *string `locationName:"description" type:"string"`

	// A Boolean value indicating whether the parameter can be modified.
	IsModifiable *bool `locationName:"isModifiable" type:"boolean"`

	// Specifies the name of the parameter.
	ParameterName *string `locationName:"parameterName" type:"string"`

	// Specifies the value of the parameter.
	ParameterValue *string `locationName:"parameterValue" type:"string"`
	// contains filtered or unexported fields
}

Describes the parameters of a database.

func (RelationalDatabaseParameter) GoString added in v1.99.0

func (s RelationalDatabaseParameter) GoString() string

GoString returns the string representation

func (*RelationalDatabaseParameter) SetAllowedValues added in v1.99.0

SetAllowedValues sets the AllowedValues field's value.

func (*RelationalDatabaseParameter) SetApplyMethod added in v1.99.0

SetApplyMethod sets the ApplyMethod field's value.

func (*RelationalDatabaseParameter) SetApplyType added in v1.99.0

SetApplyType sets the ApplyType field's value.

func (*RelationalDatabaseParameter) SetDataType added in v1.99.0

SetDataType sets the DataType field's value.

func (*RelationalDatabaseParameter) SetDescription added in v1.99.0

SetDescription sets the Description field's value.

func (*RelationalDatabaseParameter) SetIsModifiable added in v1.99.0

SetIsModifiable sets the IsModifiable field's value.

func (*RelationalDatabaseParameter) SetParameterName added in v1.99.0

SetParameterName sets the ParameterName field's value.

func (*RelationalDatabaseParameter) SetParameterValue added in v1.99.0

SetParameterValue sets the ParameterValue field's value.

func (RelationalDatabaseParameter) String added in v1.99.0

String returns the string representation

type RelationalDatabaseSnapshot added in v1.99.0

type RelationalDatabaseSnapshot struct {

	// The Amazon Resource Name (ARN) of the database snapshot.
	Arn *string `locationName:"arn" type:"string"`

	// The timestamp when the database snapshot was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The software of the database snapshot (for example, MySQL)
	Engine *string `locationName:"engine" type:"string"`

	// The database engine version for the database snapshot (for example, 5.7.23).
	EngineVersion *string `locationName:"engineVersion" type:"string"`

	// The Amazon Resource Name (ARN) of the database from which the database snapshot
	// was created.
	FromRelationalDatabaseArn *string `locationName:"fromRelationalDatabaseArn" type:"string"`

	// The blueprint ID of the database from which the database snapshot was created.
	// A blueprint describes the major engine version of a database.
	FromRelationalDatabaseBlueprintId *string `locationName:"fromRelationalDatabaseBlueprintId" type:"string"`

	// The bundle ID of the database from which the database snapshot was created.
	FromRelationalDatabaseBundleId *string `locationName:"fromRelationalDatabaseBundleId" type:"string"`

	// The name of the source database from which the database snapshot was created.
	FromRelationalDatabaseName *string `locationName:"fromRelationalDatabaseName" type:"string"`

	// The Region name and Availability Zone where the database snapshot is located.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the database snapshot.
	Name *string `locationName:"name" type:"string"`

	// The Lightsail resource type.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The size of the disk in GB (for example, 32) for the database snapshot.
	SizeInGb *int64 `locationName:"sizeInGb" type:"integer"`

	// The state of the database snapshot.
	State *string `locationName:"state" type:"string"`

	// The support code for the database snapshot. Include this code in your email
	// to support when you have questions about a database snapshot in Lightsail.
	// This code enables our support team to look up your Lightsail information
	// more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`

	// The tag keys and optional values for the resource. 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 []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a database snapshot.

func (RelationalDatabaseSnapshot) GoString added in v1.99.0

func (s RelationalDatabaseSnapshot) GoString() string

GoString returns the string representation

func (*RelationalDatabaseSnapshot) SetArn added in v1.99.0

SetArn sets the Arn field's value.

func (*RelationalDatabaseSnapshot) SetCreatedAt added in v1.99.0

SetCreatedAt sets the CreatedAt field's value.

func (*RelationalDatabaseSnapshot) SetEngine added in v1.99.0

SetEngine sets the Engine field's value.

func (*RelationalDatabaseSnapshot) SetEngineVersion added in v1.99.0

SetEngineVersion sets the EngineVersion field's value.

func (*RelationalDatabaseSnapshot) SetFromRelationalDatabaseArn added in v1.99.0

func (s *RelationalDatabaseSnapshot) SetFromRelationalDatabaseArn(v string) *RelationalDatabaseSnapshot

SetFromRelationalDatabaseArn sets the FromRelationalDatabaseArn field's value.

func (*RelationalDatabaseSnapshot) SetFromRelationalDatabaseBlueprintId added in v1.99.0

func (s *RelationalDatabaseSnapshot) SetFromRelationalDatabaseBlueprintId(v string) *RelationalDatabaseSnapshot

SetFromRelationalDatabaseBlueprintId sets the FromRelationalDatabaseBlueprintId field's value.

func (*RelationalDatabaseSnapshot) SetFromRelationalDatabaseBundleId added in v1.99.0

func (s *RelationalDatabaseSnapshot) SetFromRelationalDatabaseBundleId(v string) *RelationalDatabaseSnapshot

SetFromRelationalDatabaseBundleId sets the FromRelationalDatabaseBundleId field's value.

func (*RelationalDatabaseSnapshot) SetFromRelationalDatabaseName added in v1.99.0

func (s *RelationalDatabaseSnapshot) SetFromRelationalDatabaseName(v string) *RelationalDatabaseSnapshot

SetFromRelationalDatabaseName sets the FromRelationalDatabaseName field's value.

func (*RelationalDatabaseSnapshot) SetLocation added in v1.99.0

SetLocation sets the Location field's value.

func (*RelationalDatabaseSnapshot) SetName added in v1.99.0

SetName sets the Name field's value.

func (*RelationalDatabaseSnapshot) SetResourceType added in v1.99.0

SetResourceType sets the ResourceType field's value.

func (*RelationalDatabaseSnapshot) SetSizeInGb added in v1.99.0

SetSizeInGb sets the SizeInGb field's value.

func (*RelationalDatabaseSnapshot) SetState added in v1.99.0

SetState sets the State field's value.

func (*RelationalDatabaseSnapshot) SetSupportCode added in v1.99.0

SetSupportCode sets the SupportCode field's value.

func (*RelationalDatabaseSnapshot) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (RelationalDatabaseSnapshot) String added in v1.99.0

String returns the string representation

type ReleaseStaticIpInput

type ReleaseStaticIpInput struct {

	// The name of the static IP to delete.
	//
	// StaticIpName is a required field
	StaticIpName *string `locationName:"staticIpName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ReleaseStaticIpInput) GoString

func (s ReleaseStaticIpInput) GoString() string

GoString returns the string representation

func (*ReleaseStaticIpInput) SetStaticIpName

func (s *ReleaseStaticIpInput) SetStaticIpName(v string) *ReleaseStaticIpInput

SetStaticIpName sets the StaticIpName field's value.

func (ReleaseStaticIpInput) String

func (s ReleaseStaticIpInput) String() string

String returns the string representation

func (*ReleaseStaticIpInput) Validate

func (s *ReleaseStaticIpInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReleaseStaticIpOutput

type ReleaseStaticIpOutput struct {

	// An array of key-value pairs containing information about the request operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (ReleaseStaticIpOutput) GoString

func (s ReleaseStaticIpOutput) GoString() string

GoString returns the string representation

func (*ReleaseStaticIpOutput) SetOperations

func (s *ReleaseStaticIpOutput) SetOperations(v []*Operation) *ReleaseStaticIpOutput

SetOperations sets the Operations field's value.

func (ReleaseStaticIpOutput) String

func (s ReleaseStaticIpOutput) String() string

String returns the string representation

type ResourceLocation

type ResourceLocation struct {

	// The Availability Zone. Follows the format us-east-2a (case-sensitive).
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The AWS Region name.
	RegionName *string `locationName:"regionName" type:"string" enum:"RegionName"`
	// contains filtered or unexported fields
}

Describes the resource location.

func (ResourceLocation) GoString

func (s ResourceLocation) GoString() string

GoString returns the string representation

func (*ResourceLocation) SetAvailabilityZone

func (s *ResourceLocation) SetAvailabilityZone(v string) *ResourceLocation

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*ResourceLocation) SetRegionName

func (s *ResourceLocation) SetRegionName(v string) *ResourceLocation

SetRegionName sets the RegionName field's value.

func (ResourceLocation) String

func (s ResourceLocation) String() string

String returns the string representation

type StartInstanceInput

type StartInstanceInput struct {

	// The name of the instance (a virtual private server) to start.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartInstanceInput) GoString

func (s StartInstanceInput) GoString() string

GoString returns the string representation

func (*StartInstanceInput) SetInstanceName

func (s *StartInstanceInput) SetInstanceName(v string) *StartInstanceInput

SetInstanceName sets the InstanceName field's value.

func (StartInstanceInput) String

func (s StartInstanceInput) String() string

String returns the string representation

func (*StartInstanceInput) Validate

func (s *StartInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartInstanceOutput

type StartInstanceOutput struct {

	// An array of key-value pairs containing information about the request operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (StartInstanceOutput) GoString

func (s StartInstanceOutput) GoString() string

GoString returns the string representation

func (*StartInstanceOutput) SetOperations

func (s *StartInstanceOutput) SetOperations(v []*Operation) *StartInstanceOutput

SetOperations sets the Operations field's value.

func (StartInstanceOutput) String

func (s StartInstanceOutput) String() string

String returns the string representation

type StartRelationalDatabaseInput added in v1.99.0

type StartRelationalDatabaseInput struct {

	// The name of your database to start.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartRelationalDatabaseInput) GoString added in v1.99.0

func (s StartRelationalDatabaseInput) GoString() string

GoString returns the string representation

func (*StartRelationalDatabaseInput) SetRelationalDatabaseName added in v1.99.0

func (s *StartRelationalDatabaseInput) SetRelationalDatabaseName(v string) *StartRelationalDatabaseInput

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (StartRelationalDatabaseInput) String added in v1.99.0

String returns the string representation

func (*StartRelationalDatabaseInput) Validate added in v1.99.0

func (s *StartRelationalDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartRelationalDatabaseOutput added in v1.99.0

type StartRelationalDatabaseOutput struct {

	// An object describing the result of your start relational database request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (StartRelationalDatabaseOutput) GoString added in v1.99.0

GoString returns the string representation

func (*StartRelationalDatabaseOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (StartRelationalDatabaseOutput) String added in v1.99.0

String returns the string representation

type StaticIp

type StaticIp struct {

	// The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
	Arn *string `locationName:"arn" type:"string"`

	// The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).
	AttachedTo *string `locationName:"attachedTo" type:"string"`

	// The timestamp when the static IP was created (e.g., 1479735304.222).
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The static IP address.
	IpAddress *string `locationName:"ipAddress" type:"string"`

	// A Boolean value indicating whether the static IP is attached.
	IsAttached *bool `locationName:"isAttached" type:"boolean"`

	// The region and Availability Zone where the static IP was created.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).
	Name *string `locationName:"name" type:"string"`

	// The resource type (usually StaticIp).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The support code. Include this code in your email to support when you have
	// questions about an instance or another resource in Lightsail. This code enables
	// our support team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`
	// contains filtered or unexported fields
}

Describes the static IP.

func (StaticIp) GoString

func (s StaticIp) GoString() string

GoString returns the string representation

func (*StaticIp) SetArn

func (s *StaticIp) SetArn(v string) *StaticIp

SetArn sets the Arn field's value.

func (*StaticIp) SetAttachedTo

func (s *StaticIp) SetAttachedTo(v string) *StaticIp

SetAttachedTo sets the AttachedTo field's value.

func (*StaticIp) SetCreatedAt

func (s *StaticIp) SetCreatedAt(v time.Time) *StaticIp

SetCreatedAt sets the CreatedAt field's value.

func (*StaticIp) SetIpAddress

func (s *StaticIp) SetIpAddress(v string) *StaticIp

SetIpAddress sets the IpAddress field's value.

func (*StaticIp) SetIsAttached

func (s *StaticIp) SetIsAttached(v bool) *StaticIp

SetIsAttached sets the IsAttached field's value.

func (*StaticIp) SetLocation

func (s *StaticIp) SetLocation(v *ResourceLocation) *StaticIp

SetLocation sets the Location field's value.

func (*StaticIp) SetName

func (s *StaticIp) SetName(v string) *StaticIp

SetName sets the Name field's value.

func (*StaticIp) SetResourceType

func (s *StaticIp) SetResourceType(v string) *StaticIp

SetResourceType sets the ResourceType field's value.

func (*StaticIp) SetSupportCode

func (s *StaticIp) SetSupportCode(v string) *StaticIp

SetSupportCode sets the SupportCode field's value.

func (StaticIp) String

func (s StaticIp) String() string

String returns the string representation

type StopInstanceInput

type StopInstanceInput struct {

	// 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 `locationName:"force" type:"boolean"`

	// The name of the instance (a virtual private server) to stop.
	//
	// InstanceName is a required field
	InstanceName *string `locationName:"instanceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopInstanceInput) GoString

func (s StopInstanceInput) GoString() string

GoString returns the string representation

func (*StopInstanceInput) SetForce added in v1.12.27

func (s *StopInstanceInput) SetForce(v bool) *StopInstanceInput

SetForce sets the Force field's value.

func (*StopInstanceInput) SetInstanceName

func (s *StopInstanceInput) SetInstanceName(v string) *StopInstanceInput

SetInstanceName sets the InstanceName field's value.

func (StopInstanceInput) String

func (s StopInstanceInput) String() string

String returns the string representation

func (*StopInstanceInput) Validate

func (s *StopInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopInstanceOutput

type StopInstanceOutput struct {

	// An array of key-value pairs containing information about the request operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (StopInstanceOutput) GoString

func (s StopInstanceOutput) GoString() string

GoString returns the string representation

func (*StopInstanceOutput) SetOperations

func (s *StopInstanceOutput) SetOperations(v []*Operation) *StopInstanceOutput

SetOperations sets the Operations field's value.

func (StopInstanceOutput) String

func (s StopInstanceOutput) String() string

String returns the string representation

type StopRelationalDatabaseInput added in v1.99.0

type StopRelationalDatabaseInput struct {

	// The name of your database to stop.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`

	// The name of your new database snapshot to be created before stopping your
	// database.
	RelationalDatabaseSnapshotName *string `locationName:"relationalDatabaseSnapshotName" type:"string"`
	// contains filtered or unexported fields
}

func (StopRelationalDatabaseInput) GoString added in v1.99.0

func (s StopRelationalDatabaseInput) GoString() string

GoString returns the string representation

func (*StopRelationalDatabaseInput) SetRelationalDatabaseName added in v1.99.0

func (s *StopRelationalDatabaseInput) SetRelationalDatabaseName(v string) *StopRelationalDatabaseInput

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*StopRelationalDatabaseInput) SetRelationalDatabaseSnapshotName added in v1.99.0

func (s *StopRelationalDatabaseInput) SetRelationalDatabaseSnapshotName(v string) *StopRelationalDatabaseInput

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (StopRelationalDatabaseInput) String added in v1.99.0

String returns the string representation

func (*StopRelationalDatabaseInput) Validate added in v1.99.0

func (s *StopRelationalDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopRelationalDatabaseOutput added in v1.99.0

type StopRelationalDatabaseOutput struct {

	// An object describing the result of your stop relational database request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (StopRelationalDatabaseOutput) GoString added in v1.99.0

func (s StopRelationalDatabaseOutput) GoString() string

GoString returns the string representation

func (*StopRelationalDatabaseOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (StopRelationalDatabaseOutput) String added in v1.99.0

String returns the string representation

type Tag added in v1.99.0

type Tag struct {

	// The key of the tag.
	//
	// Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in
	// UTF-8, or the following characters: + - = . _ : / @
	Key *string `locationName:"key" type:"string"`

	// The value of the tag.
	//
	// Constraints: Tag values accept a maximum of 256 letters, numbers, spaces
	// in UTF-8, or the following characters: + - = . _ : / @
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags).

func (Tag) GoString added in v1.99.0

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.99.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.99.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.99.0

func (s Tag) String() string

String returns the string representation

type TagResourceInput added in v1.99.0

type TagResourceInput struct {

	// The name of the resource to which you are adding tags.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`

	// The tag key and optional value.
	//
	// Tags is a required field
	Tags []*Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.99.0

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceName added in v1.99.0

func (s *TagResourceInput) SetResourceName(v string) *TagResourceInput

SetResourceName sets the ResourceName field's value.

func (*TagResourceInput) SetTags added in v1.99.0

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.99.0

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.99.0

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.99.0

type TagResourceOutput struct {

	// A list of objects describing the API operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.99.0

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (*TagResourceOutput) SetOperations added in v1.99.0

func (s *TagResourceOutput) SetOperations(v []*Operation) *TagResourceOutput

SetOperations sets the Operations field's value.

func (TagResourceOutput) String added in v1.99.0

func (s TagResourceOutput) String() string

String returns the string representation

type UnpeerVpcInput

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

func (UnpeerVpcInput) GoString

func (s UnpeerVpcInput) GoString() string

GoString returns the string representation

func (UnpeerVpcInput) String

func (s UnpeerVpcInput) String() string

String returns the string representation

type UnpeerVpcOutput

type UnpeerVpcOutput struct {

	// An array of key-value pairs containing information about the request operation.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (UnpeerVpcOutput) GoString

func (s UnpeerVpcOutput) GoString() string

GoString returns the string representation

func (*UnpeerVpcOutput) SetOperation

func (s *UnpeerVpcOutput) SetOperation(v *Operation) *UnpeerVpcOutput

SetOperation sets the Operation field's value.

func (UnpeerVpcOutput) String

func (s UnpeerVpcOutput) String() string

String returns the string representation

type UntagResourceInput added in v1.99.0

type UntagResourceInput struct {

	// The name of the resource from which you are removing a tag.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`

	// The tag keys to delete from the specified resource.
	//
	// TagKeys is a required field
	TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.99.0

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceName added in v1.99.0

func (s *UntagResourceInput) SetResourceName(v string) *UntagResourceInput

SetResourceName sets the ResourceName field's value.

func (*UntagResourceInput) SetTagKeys added in v1.99.0

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.99.0

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.99.0

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.99.0

type UntagResourceOutput struct {

	// A list of objects describing the API operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.99.0

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (*UntagResourceOutput) SetOperations added in v1.99.0

func (s *UntagResourceOutput) SetOperations(v []*Operation) *UntagResourceOutput

SetOperations sets the Operations field's value.

func (UntagResourceOutput) String added in v1.99.0

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateDomainEntryInput

type UpdateDomainEntryInput struct {

	// An array of key-value pairs containing information about the domain entry.
	//
	// DomainEntry is a required field
	DomainEntry *DomainEntry `locationName:"domainEntry" type:"structure" required:"true"`

	// The name of the domain recordset to update.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDomainEntryInput) GoString

func (s UpdateDomainEntryInput) GoString() string

GoString returns the string representation

func (*UpdateDomainEntryInput) SetDomainEntry

SetDomainEntry sets the DomainEntry field's value.

func (*UpdateDomainEntryInput) SetDomainName

SetDomainName sets the DomainName field's value.

func (UpdateDomainEntryInput) String

func (s UpdateDomainEntryInput) String() string

String returns the string representation

func (*UpdateDomainEntryInput) Validate

func (s *UpdateDomainEntryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDomainEntryOutput

type UpdateDomainEntryOutput struct {

	// An array of key-value pairs containing information about the request operation.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateDomainEntryOutput) GoString

func (s UpdateDomainEntryOutput) GoString() string

GoString returns the string representation

func (*UpdateDomainEntryOutput) SetOperations

SetOperations sets the Operations field's value.

func (UpdateDomainEntryOutput) String

func (s UpdateDomainEntryOutput) String() string

String returns the string representation

type UpdateLoadBalancerAttributeInput added in v1.12.37

type UpdateLoadBalancerAttributeInput struct {

	// The name of the attribute you want to update. Valid values are below.
	//
	// AttributeName is a required field
	AttributeName *string `locationName:"attributeName" type:"string" required:"true" enum:"LoadBalancerAttributeName"`

	// The value that you want to specify for the attribute name.
	//
	// AttributeValue is a required field
	AttributeValue *string `locationName:"attributeValue" min:"1" type:"string" required:"true"`

	// The name of the load balancer that you want to modify (e.g., my-load-balancer.
	//
	// LoadBalancerName is a required field
	LoadBalancerName *string `locationName:"loadBalancerName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateLoadBalancerAttributeInput) GoString added in v1.12.37

GoString returns the string representation

func (*UpdateLoadBalancerAttributeInput) SetAttributeName added in v1.12.37

SetAttributeName sets the AttributeName field's value.

func (*UpdateLoadBalancerAttributeInput) SetAttributeValue added in v1.12.37

SetAttributeValue sets the AttributeValue field's value.

func (*UpdateLoadBalancerAttributeInput) SetLoadBalancerName added in v1.12.37

SetLoadBalancerName sets the LoadBalancerName field's value.

func (UpdateLoadBalancerAttributeInput) String added in v1.12.37

String returns the string representation

func (*UpdateLoadBalancerAttributeInput) Validate added in v1.12.37

Validate inspects the fields of the type to determine if they are valid.

type UpdateLoadBalancerAttributeOutput added in v1.12.37

type UpdateLoadBalancerAttributeOutput struct {

	// An object describing the API operations.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateLoadBalancerAttributeOutput) GoString added in v1.12.37

GoString returns the string representation

func (*UpdateLoadBalancerAttributeOutput) SetOperations added in v1.12.37

SetOperations sets the Operations field's value.

func (UpdateLoadBalancerAttributeOutput) String added in v1.12.37

String returns the string representation

type UpdateRelationalDatabaseInput added in v1.99.0

type UpdateRelationalDatabaseInput struct {

	// When true, applies changes immediately. When false, applies changes during
	// the preferred maintenance window. Some changes may cause an outage.
	//
	// Default: false
	ApplyImmediately *bool `locationName:"applyImmediately" type:"boolean"`

	// 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 `locationName:"disableBackupRetention" type:"boolean"`

	// 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 `locationName:"enableBackupRetention" type:"boolean"`

	// 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 `locationName:"masterUserPassword" type:"string" sensitive:"true"`

	// 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 Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `locationName:"preferredBackupWindow" type:"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 Universal Coordinated Time (UTC).
	//
	//    * Example: Tue:17:00-Tue:17:30
	PreferredMaintenanceWindow *string `locationName:"preferredMaintenanceWindow" type:"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 `locationName:"publiclyAccessible" type:"boolean"`

	// The name of your database to update.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`

	// 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 `locationName:"rotateMasterUserPassword" type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdateRelationalDatabaseInput) GoString added in v1.99.0

GoString returns the string representation

func (*UpdateRelationalDatabaseInput) SetApplyImmediately added in v1.99.0

SetApplyImmediately sets the ApplyImmediately field's value.

func (*UpdateRelationalDatabaseInput) SetDisableBackupRetention added in v1.99.0

func (s *UpdateRelationalDatabaseInput) SetDisableBackupRetention(v bool) *UpdateRelationalDatabaseInput

SetDisableBackupRetention sets the DisableBackupRetention field's value.

func (*UpdateRelationalDatabaseInput) SetEnableBackupRetention added in v1.99.0

func (s *UpdateRelationalDatabaseInput) SetEnableBackupRetention(v bool) *UpdateRelationalDatabaseInput

SetEnableBackupRetention sets the EnableBackupRetention field's value.

func (*UpdateRelationalDatabaseInput) SetMasterUserPassword added in v1.99.0

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*UpdateRelationalDatabaseInput) SetPreferredBackupWindow added in v1.99.0

func (s *UpdateRelationalDatabaseInput) SetPreferredBackupWindow(v string) *UpdateRelationalDatabaseInput

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*UpdateRelationalDatabaseInput) SetPreferredMaintenanceWindow added in v1.99.0

func (s *UpdateRelationalDatabaseInput) SetPreferredMaintenanceWindow(v string) *UpdateRelationalDatabaseInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*UpdateRelationalDatabaseInput) SetPubliclyAccessible added in v1.99.0

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*UpdateRelationalDatabaseInput) SetRelationalDatabaseName added in v1.99.0

func (s *UpdateRelationalDatabaseInput) SetRelationalDatabaseName(v string) *UpdateRelationalDatabaseInput

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*UpdateRelationalDatabaseInput) SetRotateMasterUserPassword added in v1.99.0

func (s *UpdateRelationalDatabaseInput) SetRotateMasterUserPassword(v bool) *UpdateRelationalDatabaseInput

SetRotateMasterUserPassword sets the RotateMasterUserPassword field's value.

func (UpdateRelationalDatabaseInput) String added in v1.99.0

String returns the string representation

func (*UpdateRelationalDatabaseInput) Validate added in v1.99.0

func (s *UpdateRelationalDatabaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateRelationalDatabaseOutput added in v1.99.0

type UpdateRelationalDatabaseOutput struct {

	// An object describing the result of your update relational database request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateRelationalDatabaseOutput) GoString added in v1.99.0

GoString returns the string representation

func (*UpdateRelationalDatabaseOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (UpdateRelationalDatabaseOutput) String added in v1.99.0

String returns the string representation

type UpdateRelationalDatabaseParametersInput added in v1.99.0

type UpdateRelationalDatabaseParametersInput struct {

	// The database parameters to update.
	//
	// Parameters is a required field
	Parameters []*RelationalDatabaseParameter `locationName:"parameters" type:"list" required:"true"`

	// The name of your database for which to update parameters.
	//
	// RelationalDatabaseName is a required field
	RelationalDatabaseName *string `locationName:"relationalDatabaseName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRelationalDatabaseParametersInput) GoString added in v1.99.0

GoString returns the string representation

func (*UpdateRelationalDatabaseParametersInput) SetParameters added in v1.99.0

SetParameters sets the Parameters field's value.

func (*UpdateRelationalDatabaseParametersInput) SetRelationalDatabaseName added in v1.99.0

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (UpdateRelationalDatabaseParametersInput) String added in v1.99.0

String returns the string representation

func (*UpdateRelationalDatabaseParametersInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type UpdateRelationalDatabaseParametersOutput added in v1.99.0

type UpdateRelationalDatabaseParametersOutput struct {

	// An object describing the result of your update relational database parameters
	// request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateRelationalDatabaseParametersOutput) GoString added in v1.99.0

GoString returns the string representation

func (*UpdateRelationalDatabaseParametersOutput) SetOperations added in v1.99.0

SetOperations sets the Operations field's value.

func (UpdateRelationalDatabaseParametersOutput) String added in v1.99.0

String returns the string representation

Directories

Path Synopsis
Package lightsailiface provides an interface to enable mocking the Amazon Lightsail service client for testing your code.
Package lightsailiface provides an interface to enable mocking the Amazon Lightsail service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL