lightsail

package
v1.44.174 Latest Latest
Warning

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

 Go to latest Published: Jan 5, 2023 License: Apache-2.0 Imports: 10 Imported by: 300

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 Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.

You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli).

This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the Amazon Web Services General Reference.

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 (
	// AccessTypePublic is a AccessType enum value
	AccessTypePublic = "public"

	// AccessTypePrivate is a AccessType enum value
	AccessTypePrivate = "private"
)
View Source 
const (
	// AccountLevelBpaSyncStatusInSync is a AccountLevelBpaSyncStatus enum value
	AccountLevelBpaSyncStatusInSync = "InSync"

	// AccountLevelBpaSyncStatusFailed is a AccountLevelBpaSyncStatus enum value
	AccountLevelBpaSyncStatusFailed = "Failed"

	// AccountLevelBpaSyncStatusNeverSynced is a AccountLevelBpaSyncStatus enum value
	AccountLevelBpaSyncStatusNeverSynced = "NeverSynced"

	// AccountLevelBpaSyncStatusDefaulted is a AccountLevelBpaSyncStatus enum value
	AccountLevelBpaSyncStatusDefaulted = "Defaulted"
)
View Source 
const (
	// AlarmStateOk is a AlarmState enum value
	AlarmStateOk = "OK"

	// AlarmStateAlarm is a AlarmState enum value
	AlarmStateAlarm = "ALARM"

	// AlarmStateInsufficientData is a AlarmState enum value
	AlarmStateInsufficientData = "INSUFFICIENT_DATA"
)
View Source 
const (
	// AutoSnapshotStatusSuccess is a AutoSnapshotStatus enum value
	AutoSnapshotStatusSuccess = "Success"

	// AutoSnapshotStatusFailed is a AutoSnapshotStatus enum value
	AutoSnapshotStatusFailed = "Failed"

	// AutoSnapshotStatusInProgress is a AutoSnapshotStatus enum value
	AutoSnapshotStatusInProgress = "InProgress"

	// AutoSnapshotStatusNotFound is a AutoSnapshotStatus enum value
	AutoSnapshotStatusNotFound = "NotFound"
)
View Source 
const (
	// BPAStatusMessageDefaultedForSlrMissing is a BPAStatusMessage enum value
	BPAStatusMessageDefaultedForSlrMissing = "DEFAULTED_FOR_SLR_MISSING"

	// BPAStatusMessageSyncOnHold is a BPAStatusMessage enum value
	BPAStatusMessageSyncOnHold = "SYNC_ON_HOLD"

	// BPAStatusMessageDefaultedForSlrMissingOnHold is a BPAStatusMessage enum value
	BPAStatusMessageDefaultedForSlrMissingOnHold = "DEFAULTED_FOR_SLR_MISSING_ON_HOLD"

	// BPAStatusMessageUnknown is a BPAStatusMessage enum value
	BPAStatusMessageUnknown = "Unknown"
)
View Source 
const (
	// BehaviorEnumDontCache is a BehaviorEnum enum value
	BehaviorEnumDontCache = "dont-cache"

	// BehaviorEnumCache is a BehaviorEnum enum value
	BehaviorEnumCache = "cache"
)
View Source 
const (
	// BlueprintTypeOs is a BlueprintType enum value
	BlueprintTypeOs = "os"

	// BlueprintTypeApp is a BlueprintType enum value
	BlueprintTypeApp = "app"
)
View Source 
const (
	// BucketMetricNameBucketSizeBytes is a BucketMetricName enum value
	BucketMetricNameBucketSizeBytes = "BucketSizeBytes"

	// BucketMetricNameNumberOfObjects is a BucketMetricName enum value
	BucketMetricNameNumberOfObjects = "NumberOfObjects"
)
View Source 
const (
	// CertificateDomainValidationStatusPendingValidation is a CertificateDomainValidationStatus enum value
	CertificateDomainValidationStatusPendingValidation = "PENDING_VALIDATION"

	// CertificateDomainValidationStatusFailed is a CertificateDomainValidationStatus enum value
	CertificateDomainValidationStatusFailed = "FAILED"

	// CertificateDomainValidationStatusSuccess is a CertificateDomainValidationStatus enum value
	CertificateDomainValidationStatusSuccess = "SUCCESS"
)
View Source 
const (
	// CertificateStatusPendingValidation is a CertificateStatus enum value
	CertificateStatusPendingValidation = "PENDING_VALIDATION"

	// CertificateStatusIssued is a CertificateStatus enum value
	CertificateStatusIssued = "ISSUED"

	// CertificateStatusInactive is a CertificateStatus enum value
	CertificateStatusInactive = "INACTIVE"

	// CertificateStatusExpired is a CertificateStatus enum value
	CertificateStatusExpired = "EXPIRED"

	// CertificateStatusValidationTimedOut is a CertificateStatus enum value
	CertificateStatusValidationTimedOut = "VALIDATION_TIMED_OUT"

	// CertificateStatusRevoked is a CertificateStatus enum value
	CertificateStatusRevoked = "REVOKED"

	// CertificateStatusFailed is a CertificateStatus enum value
	CertificateStatusFailed = "FAILED"
)
View Source 
const (
	// ComparisonOperatorGreaterThanOrEqualToThreshold is a ComparisonOperator enum value
	ComparisonOperatorGreaterThanOrEqualToThreshold = "GreaterThanOrEqualToThreshold"

	// ComparisonOperatorGreaterThanThreshold is a ComparisonOperator enum value
	ComparisonOperatorGreaterThanThreshold = "GreaterThanThreshold"

	// ComparisonOperatorLessThanThreshold is a ComparisonOperator enum value
	ComparisonOperatorLessThanThreshold = "LessThanThreshold"

	// ComparisonOperatorLessThanOrEqualToThreshold is a ComparisonOperator enum value
	ComparisonOperatorLessThanOrEqualToThreshold = "LessThanOrEqualToThreshold"
)
View Source 
const (
	// ContactMethodStatusPendingVerification is a ContactMethodStatus enum value
	ContactMethodStatusPendingVerification = "PendingVerification"

	// ContactMethodStatusValid is a ContactMethodStatus enum value
	ContactMethodStatusValid = "Valid"

	// ContactMethodStatusInvalid is a ContactMethodStatus enum value
	ContactMethodStatusInvalid = "Invalid"
)
View Source 
const (
	// ContactProtocolEmail is a ContactProtocol enum value
	ContactProtocolEmail = "Email"

	// ContactProtocolSms is a ContactProtocol enum value
	ContactProtocolSms = "SMS"
)
View Source 
const (
	// ContainerServiceDeploymentStateActivating is a ContainerServiceDeploymentState enum value
	ContainerServiceDeploymentStateActivating = "ACTIVATING"

	// ContainerServiceDeploymentStateActive is a ContainerServiceDeploymentState enum value
	ContainerServiceDeploymentStateActive = "ACTIVE"

	// ContainerServiceDeploymentStateInactive is a ContainerServiceDeploymentState enum value
	ContainerServiceDeploymentStateInactive = "INACTIVE"

	// ContainerServiceDeploymentStateFailed is a ContainerServiceDeploymentState enum value
	ContainerServiceDeploymentStateFailed = "FAILED"
)
View Source 
const (
	// ContainerServiceMetricNameCpuutilization is a ContainerServiceMetricName enum value
	ContainerServiceMetricNameCpuutilization = "CPUUtilization"

	// ContainerServiceMetricNameMemoryUtilization is a ContainerServiceMetricName enum value
	ContainerServiceMetricNameMemoryUtilization = "MemoryUtilization"
)
View Source 
const (
	// ContainerServicePowerNameNano is a ContainerServicePowerName enum value
	ContainerServicePowerNameNano = "nano"

	// ContainerServicePowerNameMicro is a ContainerServicePowerName enum value
	ContainerServicePowerNameMicro = "micro"

	// ContainerServicePowerNameSmall is a ContainerServicePowerName enum value
	ContainerServicePowerNameSmall = "small"

	// ContainerServicePowerNameMedium is a ContainerServicePowerName enum value
	ContainerServicePowerNameMedium = "medium"

	// ContainerServicePowerNameLarge is a ContainerServicePowerName enum value
	ContainerServicePowerNameLarge = "large"

	// ContainerServicePowerNameXlarge is a ContainerServicePowerName enum value
	ContainerServicePowerNameXlarge = "xlarge"
)
View Source 
const (
	// ContainerServiceProtocolHttp is a ContainerServiceProtocol enum value
	ContainerServiceProtocolHttp = "HTTP"

	// ContainerServiceProtocolHttps is a ContainerServiceProtocol enum value
	ContainerServiceProtocolHttps = "HTTPS"

	// ContainerServiceProtocolTcp is a ContainerServiceProtocol enum value
	ContainerServiceProtocolTcp = "TCP"

	// ContainerServiceProtocolUdp is a ContainerServiceProtocol enum value
	ContainerServiceProtocolUdp = "UDP"
)
View Source 
const (
	// ContainerServiceStatePending is a ContainerServiceState enum value
	ContainerServiceStatePending = "PENDING"

	// ContainerServiceStateReady is a ContainerServiceState enum value
	ContainerServiceStateReady = "READY"

	// ContainerServiceStateRunning is a ContainerServiceState enum value
	ContainerServiceStateRunning = "RUNNING"

	// ContainerServiceStateUpdating is a ContainerServiceState enum value
	ContainerServiceStateUpdating = "UPDATING"

	// ContainerServiceStateDeleting is a ContainerServiceState enum value
	ContainerServiceStateDeleting = "DELETING"

	// ContainerServiceStateDisabled is a ContainerServiceState enum value
	ContainerServiceStateDisabled = "DISABLED"

	// ContainerServiceStateDeploying is a ContainerServiceState enum value
	ContainerServiceStateDeploying = "DEPLOYING"
)
View Source 
const (
	// ContainerServiceStateDetailCodeCreatingSystemResources is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeCreatingSystemResources = "CREATING_SYSTEM_RESOURCES"

	// ContainerServiceStateDetailCodeCreatingNetworkInfrastructure is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeCreatingNetworkInfrastructure = "CREATING_NETWORK_INFRASTRUCTURE"

	// ContainerServiceStateDetailCodeProvisioningCertificate is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeProvisioningCertificate = "PROVISIONING_CERTIFICATE"

	// ContainerServiceStateDetailCodeProvisioningService is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeProvisioningService = "PROVISIONING_SERVICE"

	// ContainerServiceStateDetailCodeCreatingDeployment is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeCreatingDeployment = "CREATING_DEPLOYMENT"

	// ContainerServiceStateDetailCodeEvaluatingHealthCheck is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeEvaluatingHealthCheck = "EVALUATING_HEALTH_CHECK"

	// ContainerServiceStateDetailCodeActivatingDeployment is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeActivatingDeployment = "ACTIVATING_DEPLOYMENT"

	// ContainerServiceStateDetailCodeCertificateLimitExceeded is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeCertificateLimitExceeded = "CERTIFICATE_LIMIT_EXCEEDED"

	// ContainerServiceStateDetailCodeUnknownError is a ContainerServiceStateDetailCode enum value
	ContainerServiceStateDetailCodeUnknownError = "UNKNOWN_ERROR"
)
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 (
	// DistributionMetricNameRequests is a DistributionMetricName enum value
	DistributionMetricNameRequests = "Requests"

	// DistributionMetricNameBytesDownloaded is a DistributionMetricName enum value
	DistributionMetricNameBytesDownloaded = "BytesDownloaded"

	// DistributionMetricNameBytesUploaded is a DistributionMetricName enum value
	DistributionMetricNameBytesUploaded = "BytesUploaded"

	// DistributionMetricNameTotalErrorRate is a DistributionMetricName enum value
	DistributionMetricNameTotalErrorRate = "TotalErrorRate"

	// DistributionMetricNameHttp4xxErrorRate is a DistributionMetricName enum value
	DistributionMetricNameHttp4xxErrorRate = "Http4xxErrorRate"

	// DistributionMetricNameHttp5xxErrorRate is a DistributionMetricName enum value
	DistributionMetricNameHttp5xxErrorRate = "Http5xxErrorRate"
)
View Source 
const (
	// DnsRecordCreationStateCodeSucceeded is a DnsRecordCreationStateCode enum value
	DnsRecordCreationStateCodeSucceeded = "SUCCEEDED"

	// DnsRecordCreationStateCodeStarted is a DnsRecordCreationStateCode enum value
	DnsRecordCreationStateCodeStarted = "STARTED"

	// DnsRecordCreationStateCodeFailed is a DnsRecordCreationStateCode enum value
	DnsRecordCreationStateCodeFailed = "FAILED"
)
View Source 
const (
	// ExportSnapshotRecordSourceTypeInstanceSnapshot is a ExportSnapshotRecordSourceType enum value
	ExportSnapshotRecordSourceTypeInstanceSnapshot = "InstanceSnapshot"

	// ExportSnapshotRecordSourceTypeDiskSnapshot is a ExportSnapshotRecordSourceType enum value
	ExportSnapshotRecordSourceTypeDiskSnapshot = "DiskSnapshot"
)
View Source 
const (
	// ForwardValuesNone is a ForwardValues enum value
	ForwardValuesNone = "none"

	// ForwardValuesAllowList is a ForwardValues enum value
	ForwardValuesAllowList = "allow-list"

	// ForwardValuesAll is a ForwardValues enum value
	ForwardValuesAll = "all"
)
View Source 
const (
	// HeaderEnumAccept is a HeaderEnum enum value
	HeaderEnumAccept = "Accept"

	// HeaderEnumAcceptCharset is a HeaderEnum enum value
	HeaderEnumAcceptCharset = "Accept-Charset"

	// HeaderEnumAcceptDatetime is a HeaderEnum enum value
	HeaderEnumAcceptDatetime = "Accept-Datetime"

	// HeaderEnumAcceptEncoding is a HeaderEnum enum value
	HeaderEnumAcceptEncoding = "Accept-Encoding"

	// HeaderEnumAcceptLanguage is a HeaderEnum enum value
	HeaderEnumAcceptLanguage = "Accept-Language"

	// HeaderEnumAuthorization is a HeaderEnum enum value
	HeaderEnumAuthorization = "Authorization"

	// HeaderEnumCloudFrontForwardedProto is a HeaderEnum enum value
	HeaderEnumCloudFrontForwardedProto = "CloudFront-Forwarded-Proto"

	// HeaderEnumCloudFrontIsDesktopViewer is a HeaderEnum enum value
	HeaderEnumCloudFrontIsDesktopViewer = "CloudFront-Is-Desktop-Viewer"

	// HeaderEnumCloudFrontIsMobileViewer is a HeaderEnum enum value
	HeaderEnumCloudFrontIsMobileViewer = "CloudFront-Is-Mobile-Viewer"

	// HeaderEnumCloudFrontIsSmartTvViewer is a HeaderEnum enum value
	HeaderEnumCloudFrontIsSmartTvViewer = "CloudFront-Is-SmartTV-Viewer"

	// HeaderEnumCloudFrontIsTabletViewer is a HeaderEnum enum value
	HeaderEnumCloudFrontIsTabletViewer = "CloudFront-Is-Tablet-Viewer"

	// HeaderEnumCloudFrontViewerCountry is a HeaderEnum enum value
	HeaderEnumCloudFrontViewerCountry = "CloudFront-Viewer-Country"

	// HeaderEnumHost is a HeaderEnum enum value
	HeaderEnumHost = "Host"

	// HeaderEnumOrigin is a HeaderEnum enum value
	HeaderEnumOrigin = "Origin"

	// HeaderEnumReferer is a HeaderEnum enum value
	HeaderEnumReferer = "Referer"
)
View Source 
const (
	// HttpEndpointDisabled is a HttpEndpoint enum value
	HttpEndpointDisabled = "disabled"

	// HttpEndpointEnabled is a HttpEndpoint enum value
	HttpEndpointEnabled = "enabled"
)
View Source 
const (
	// HttpProtocolIpv6Disabled is a HttpProtocolIpv6 enum value
	HttpProtocolIpv6Disabled = "disabled"

	// HttpProtocolIpv6Enabled is a HttpProtocolIpv6 enum value
	HttpProtocolIpv6Enabled = "enabled"
)
View Source 
const (
	// HttpTokensOptional is a HttpTokens enum value
	HttpTokensOptional = "optional"

	// HttpTokensRequired is a HttpTokens enum value
	HttpTokensRequired = "required"
)
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 (
	// InstanceMetadataStatePending is a InstanceMetadataState enum value
	InstanceMetadataStatePending = "pending"

	// InstanceMetadataStateApplied is a InstanceMetadataState enum value
	InstanceMetadataStateApplied = "applied"
)
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"

	// InstanceMetricNameBurstCapacityTime is a InstanceMetricName enum value
	InstanceMetricNameBurstCapacityTime = "BurstCapacityTime"

	// InstanceMetricNameBurstCapacityPercentage is a InstanceMetricName enum value
	InstanceMetricNameBurstCapacityPercentage = "BurstCapacityPercentage"

	// InstanceMetricNameMetadataNoToken is a InstanceMetricName enum value
	InstanceMetricNameMetadataNoToken = "MetadataNoToken"
)
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 (
	// IpAddressTypeDualstack is a IpAddressType enum value
	IpAddressTypeDualstack = "dualstack"

	// IpAddressTypeIpv4 is a IpAddressType enum value
	IpAddressTypeIpv4 = "ipv4"
)
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"

	// LoadBalancerAttributeNameHttpsRedirectionEnabled is a LoadBalancerAttributeName enum value
	LoadBalancerAttributeNameHttpsRedirectionEnabled = "HttpsRedirectionEnabled"

	// LoadBalancerAttributeNameTlsPolicyName is a LoadBalancerAttributeName enum value
	LoadBalancerAttributeNameTlsPolicyName = "TlsPolicyName"
)
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 (
	// LoadBalancerTlsCertificateDnsRecordCreationStateCodeSucceeded is a LoadBalancerTlsCertificateDnsRecordCreationStateCode enum value
	LoadBalancerTlsCertificateDnsRecordCreationStateCodeSucceeded = "SUCCEEDED"

	// LoadBalancerTlsCertificateDnsRecordCreationStateCodeStarted is a LoadBalancerTlsCertificateDnsRecordCreationStateCode enum value
	LoadBalancerTlsCertificateDnsRecordCreationStateCodeStarted = "STARTED"

	// LoadBalancerTlsCertificateDnsRecordCreationStateCodeFailed is a LoadBalancerTlsCertificateDnsRecordCreationStateCode enum value
	LoadBalancerTlsCertificateDnsRecordCreationStateCodeFailed = "FAILED"
)
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 (
	// MetricNameCpuutilization is a MetricName enum value
	MetricNameCpuutilization = "CPUUtilization"

	// MetricNameNetworkIn is a MetricName enum value
	MetricNameNetworkIn = "NetworkIn"

	// MetricNameNetworkOut is a MetricName enum value
	MetricNameNetworkOut = "NetworkOut"

	// MetricNameStatusCheckFailed is a MetricName enum value
	MetricNameStatusCheckFailed = "StatusCheckFailed"

	// MetricNameStatusCheckFailedInstance is a MetricName enum value
	MetricNameStatusCheckFailedInstance = "StatusCheckFailed_Instance"

	// MetricNameStatusCheckFailedSystem is a MetricName enum value
	MetricNameStatusCheckFailedSystem = "StatusCheckFailed_System"

	// MetricNameClientTlsnegotiationErrorCount is a MetricName enum value
	MetricNameClientTlsnegotiationErrorCount = "ClientTLSNegotiationErrorCount"

	// MetricNameHealthyHostCount is a MetricName enum value
	MetricNameHealthyHostCount = "HealthyHostCount"

	// MetricNameUnhealthyHostCount is a MetricName enum value
	MetricNameUnhealthyHostCount = "UnhealthyHostCount"

	// MetricNameHttpcodeLb4xxCount is a MetricName enum value
	MetricNameHttpcodeLb4xxCount = "HTTPCode_LB_4XX_Count"

	// MetricNameHttpcodeLb5xxCount is a MetricName enum value
	MetricNameHttpcodeLb5xxCount = "HTTPCode_LB_5XX_Count"

	// MetricNameHttpcodeInstance2xxCount is a MetricName enum value
	MetricNameHttpcodeInstance2xxCount = "HTTPCode_Instance_2XX_Count"

	// MetricNameHttpcodeInstance3xxCount is a MetricName enum value
	MetricNameHttpcodeInstance3xxCount = "HTTPCode_Instance_3XX_Count"

	// MetricNameHttpcodeInstance4xxCount is a MetricName enum value
	MetricNameHttpcodeInstance4xxCount = "HTTPCode_Instance_4XX_Count"

	// MetricNameHttpcodeInstance5xxCount is a MetricName enum value
	MetricNameHttpcodeInstance5xxCount = "HTTPCode_Instance_5XX_Count"

	// MetricNameInstanceResponseTime is a MetricName enum value
	MetricNameInstanceResponseTime = "InstanceResponseTime"

	// MetricNameRejectedConnectionCount is a MetricName enum value
	MetricNameRejectedConnectionCount = "RejectedConnectionCount"

	// MetricNameRequestCount is a MetricName enum value
	MetricNameRequestCount = "RequestCount"

	// MetricNameDatabaseConnections is a MetricName enum value
	MetricNameDatabaseConnections = "DatabaseConnections"

	// MetricNameDiskQueueDepth is a MetricName enum value
	MetricNameDiskQueueDepth = "DiskQueueDepth"

	// MetricNameFreeStorageSpace is a MetricName enum value
	MetricNameFreeStorageSpace = "FreeStorageSpace"

	// MetricNameNetworkReceiveThroughput is a MetricName enum value
	MetricNameNetworkReceiveThroughput = "NetworkReceiveThroughput"

	// MetricNameNetworkTransmitThroughput is a MetricName enum value
	MetricNameNetworkTransmitThroughput = "NetworkTransmitThroughput"

	// MetricNameBurstCapacityTime is a MetricName enum value
	MetricNameBurstCapacityTime = "BurstCapacityTime"

	// MetricNameBurstCapacityPercentage is a MetricName enum value
	MetricNameBurstCapacityPercentage = "BurstCapacityPercentage"
)
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 (
	// NameServersUpdateStateCodeSucceeded is a NameServersUpdateStateCode enum value
	NameServersUpdateStateCodeSucceeded = "SUCCEEDED"

	// NameServersUpdateStateCodePending is a NameServersUpdateStateCode enum value
	NameServersUpdateStateCodePending = "PENDING"

	// NameServersUpdateStateCodeFailed is a NameServersUpdateStateCode enum value
	NameServersUpdateStateCodeFailed = "FAILED"

	// NameServersUpdateStateCodeStarted is a NameServersUpdateStateCode enum value
	NameServersUpdateStateCodeStarted = "STARTED"
)
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"

	// NetworkProtocolIcmp is a NetworkProtocol enum value
	NetworkProtocolIcmp = "icmp"
)
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"

	// OperationTypeEnableAddOn is a OperationType enum value
	OperationTypeEnableAddOn = "EnableAddOn"

	// OperationTypeDisableAddOn is a OperationType enum value
	OperationTypeDisableAddOn = "DisableAddOn"

	// OperationTypePutAlarm is a OperationType enum value
	OperationTypePutAlarm = "PutAlarm"

	// OperationTypeGetAlarms is a OperationType enum value
	OperationTypeGetAlarms = "GetAlarms"

	// OperationTypeDeleteAlarm is a OperationType enum value
	OperationTypeDeleteAlarm = "DeleteAlarm"

	// OperationTypeTestAlarm is a OperationType enum value
	OperationTypeTestAlarm = "TestAlarm"

	// OperationTypeCreateContactMethod is a OperationType enum value
	OperationTypeCreateContactMethod = "CreateContactMethod"

	// OperationTypeGetContactMethods is a OperationType enum value
	OperationTypeGetContactMethods = "GetContactMethods"

	// OperationTypeSendContactMethodVerification is a OperationType enum value
	OperationTypeSendContactMethodVerification = "SendContactMethodVerification"

	// OperationTypeDeleteContactMethod is a OperationType enum value
	OperationTypeDeleteContactMethod = "DeleteContactMethod"

	// OperationTypeCreateDistribution is a OperationType enum value
	OperationTypeCreateDistribution = "CreateDistribution"

	// OperationTypeUpdateDistribution is a OperationType enum value
	OperationTypeUpdateDistribution = "UpdateDistribution"

	// OperationTypeDeleteDistribution is a OperationType enum value
	OperationTypeDeleteDistribution = "DeleteDistribution"

	// OperationTypeResetDistributionCache is a OperationType enum value
	OperationTypeResetDistributionCache = "ResetDistributionCache"

	// OperationTypeAttachCertificateToDistribution is a OperationType enum value
	OperationTypeAttachCertificateToDistribution = "AttachCertificateToDistribution"

	// OperationTypeDetachCertificateFromDistribution is a OperationType enum value
	OperationTypeDetachCertificateFromDistribution = "DetachCertificateFromDistribution"

	// OperationTypeUpdateDistributionBundle is a OperationType enum value
	OperationTypeUpdateDistributionBundle = "UpdateDistributionBundle"

	// OperationTypeSetIpAddressType is a OperationType enum value
	OperationTypeSetIpAddressType = "SetIpAddressType"

	// OperationTypeCreateCertificate is a OperationType enum value
	OperationTypeCreateCertificate = "CreateCertificate"

	// OperationTypeDeleteCertificate is a OperationType enum value
	OperationTypeDeleteCertificate = "DeleteCertificate"

	// OperationTypeCreateContainerService is a OperationType enum value
	OperationTypeCreateContainerService = "CreateContainerService"

	// OperationTypeUpdateContainerService is a OperationType enum value
	OperationTypeUpdateContainerService = "UpdateContainerService"

	// OperationTypeDeleteContainerService is a OperationType enum value
	OperationTypeDeleteContainerService = "DeleteContainerService"

	// OperationTypeCreateContainerServiceDeployment is a OperationType enum value
	OperationTypeCreateContainerServiceDeployment = "CreateContainerServiceDeployment"

	// OperationTypeCreateContainerServiceRegistryLogin is a OperationType enum value
	OperationTypeCreateContainerServiceRegistryLogin = "CreateContainerServiceRegistryLogin"

	// OperationTypeRegisterContainerImage is a OperationType enum value
	OperationTypeRegisterContainerImage = "RegisterContainerImage"

	// OperationTypeDeleteContainerImage is a OperationType enum value
	OperationTypeDeleteContainerImage = "DeleteContainerImage"

	// OperationTypeCreateBucket is a OperationType enum value
	OperationTypeCreateBucket = "CreateBucket"

	// OperationTypeDeleteBucket is a OperationType enum value
	OperationTypeDeleteBucket = "DeleteBucket"

	// OperationTypeCreateBucketAccessKey is a OperationType enum value
	OperationTypeCreateBucketAccessKey = "CreateBucketAccessKey"

	// OperationTypeDeleteBucketAccessKey is a OperationType enum value
	OperationTypeDeleteBucketAccessKey = "DeleteBucketAccessKey"

	// OperationTypeUpdateBucketBundle is a OperationType enum value
	OperationTypeUpdateBucketBundle = "UpdateBucketBundle"

	// OperationTypeUpdateBucket is a OperationType enum value
	OperationTypeUpdateBucket = "UpdateBucket"

	// OperationTypeSetResourceAccessForBucket is a OperationType enum value
	OperationTypeSetResourceAccessForBucket = "SetResourceAccessForBucket"

	// OperationTypeUpdateInstanceMetadataOptions is a OperationType enum value
	OperationTypeUpdateInstanceMetadataOptions = "UpdateInstanceMetadataOptions"
)
View Source 
const (
	// OriginProtocolPolicyEnumHttpOnly is a OriginProtocolPolicyEnum enum value
	OriginProtocolPolicyEnumHttpOnly = "http-only"

	// OriginProtocolPolicyEnumHttpsOnly is a OriginProtocolPolicyEnum enum value
	OriginProtocolPolicyEnumHttpsOnly = "https-only"
)
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 (
	// R53HostedZoneDeletionStateCodeSucceeded is a R53HostedZoneDeletionStateCode enum value
	R53HostedZoneDeletionStateCodeSucceeded = "SUCCEEDED"

	// R53HostedZoneDeletionStateCodePending is a R53HostedZoneDeletionStateCode enum value
	R53HostedZoneDeletionStateCodePending = "PENDING"

	// R53HostedZoneDeletionStateCodeFailed is a R53HostedZoneDeletionStateCode enum value
	R53HostedZoneDeletionStateCodeFailed = "FAILED"

	// R53HostedZoneDeletionStateCodeStarted is a R53HostedZoneDeletionStateCode enum value
	R53HostedZoneDeletionStateCodeStarted = "STARTED"
)
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"

	// RegionNameEuNorth1 is a RegionName enum value
	RegionNameEuNorth1 = "eu-north-1"
)
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 (
	// RenewalStatusPendingAutoRenewal is a RenewalStatus enum value
	RenewalStatusPendingAutoRenewal = "PendingAutoRenewal"

	// RenewalStatusPendingValidation is a RenewalStatus enum value
	RenewalStatusPendingValidation = "PendingValidation"

	// RenewalStatusSuccess is a RenewalStatus enum value
	RenewalStatusSuccess = "Success"

	// RenewalStatusFailed is a RenewalStatus enum value
	RenewalStatusFailed = "Failed"
)
View Source 
const (
	// ResourceBucketAccessAllow is a ResourceBucketAccess enum value
	ResourceBucketAccessAllow = "allow"

	// ResourceBucketAccessDeny is a ResourceBucketAccess enum value
	ResourceBucketAccessDeny = "deny"
)
View Source 
const (
	// ResourceTypeContainerService is a ResourceType enum value
	ResourceTypeContainerService = "ContainerService"

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

	// ResourceTypeAlarm is a ResourceType enum value
	ResourceTypeAlarm = "Alarm"

	// ResourceTypeContactMethod is a ResourceType enum value
	ResourceTypeContactMethod = "ContactMethod"

	// ResourceTypeDistribution is a ResourceType enum value
	ResourceTypeDistribution = "Distribution"

	// ResourceTypeCertificate is a ResourceType enum value
	ResourceTypeCertificate = "Certificate"

	// ResourceTypeBucket is a ResourceType enum value
	ResourceTypeBucket = "Bucket"
)
View Source 
const (
	// StatusTypeActive is a StatusType enum value
	StatusTypeActive = "Active"

	// StatusTypeInactive is a StatusType enum value
	StatusTypeInactive = "Inactive"
)
View Source 
const (
	// TreatMissingDataBreaching is a TreatMissingData enum value
	TreatMissingDataBreaching = "breaching"

	// TreatMissingDataNotBreaching is a TreatMissingData enum value
	TreatMissingDataNotBreaching = "notBreaching"

	// TreatMissingDataIgnore is a TreatMissingData enum value
	TreatMissingDataIgnore = "ignore"

	// TreatMissingDataMissing is a TreatMissingData enum value
	TreatMissingDataMissing = "missing"
)
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 and distribution APIs are only available in the N. Virginia (us-east-1)
	// Amazon Web Services Region. Please set your Amazon Web Services 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 identifier of a specific service.
)

Service information constants

View Source 
const (
	// AddOnTypeAutoSnapshot is a AddOnType enum value
	AddOnTypeAutoSnapshot = "AutoSnapshot"
)
View Source 
const (
	// CloudFormationStackRecordSourceTypeExportSnapshotRecord is a CloudFormationStackRecordSourceType enum value
	CloudFormationStackRecordSourceTypeExportSnapshotRecord = "ExportSnapshotRecord"
)
View Source 
const (
	// ContactMethodVerificationProtocolEmail is a ContactMethodVerificationProtocol enum value
	ContactMethodVerificationProtocolEmail = "Email"
)
View Source 
const (
	// RelationalDatabaseEngineMysql is a RelationalDatabaseEngine enum value
	RelationalDatabaseEngineMysql = "mysql"
)

Variables

This section is empty.

Functions

func AccessDirection_Values added in v1.34.3 

func AccessDirection_Values() []string

AccessDirection_Values returns all elements of the AccessDirection enum

func AccessType_Values added in v1.40.0 

func AccessType_Values() []string

AccessType_Values returns all elements of the AccessType enum

func AccountLevelBpaSyncStatus_Values added in v1.43.41 

func AccountLevelBpaSyncStatus_Values() []string

AccountLevelBpaSyncStatus_Values returns all elements of the AccountLevelBpaSyncStatus enum

func AddOnType_Values added in v1.34.3 

func AddOnType_Values() []string

AddOnType_Values returns all elements of the AddOnType enum

func AlarmState_Values added in v1.34.3 

func AlarmState_Values() []string

AlarmState_Values returns all elements of the AlarmState enum

func AutoSnapshotStatus_Values added in v1.34.3 

func AutoSnapshotStatus_Values() []string

AutoSnapshotStatus_Values returns all elements of the AutoSnapshotStatus enum

func BPAStatusMessage_Values added in v1.43.41 

func BPAStatusMessage_Values() []string

BPAStatusMessage_Values returns all elements of the BPAStatusMessage enum

func BehaviorEnum_Values added in v1.34.3 

func BehaviorEnum_Values() []string

BehaviorEnum_Values returns all elements of the BehaviorEnum enum

func BlueprintType_Values added in v1.34.3 

func BlueprintType_Values() []string

BlueprintType_Values returns all elements of the BlueprintType enum

func BucketMetricName_Values added in v1.40.0 

func BucketMetricName_Values() []string

BucketMetricName_Values returns all elements of the BucketMetricName enum

func CertificateDomainValidationStatus_Values added in v1.44.133 

func CertificateDomainValidationStatus_Values() []string

CertificateDomainValidationStatus_Values returns all elements of the CertificateDomainValidationStatus enum

func CertificateStatus_Values added in v1.34.3 

func CertificateStatus_Values() []string

CertificateStatus_Values returns all elements of the CertificateStatus enum

func CloudFormationStackRecordSourceType_Values added in v1.34.3 

func CloudFormationStackRecordSourceType_Values() []string

CloudFormationStackRecordSourceType_Values returns all elements of the CloudFormationStackRecordSourceType enum

func ComparisonOperator_Values added in v1.34.3 

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func ContactMethodStatus_Values added in v1.34.3 

func ContactMethodStatus_Values() []string

ContactMethodStatus_Values returns all elements of the ContactMethodStatus enum

func ContactMethodVerificationProtocol_Values added in v1.34.3 

func ContactMethodVerificationProtocol_Values() []string

ContactMethodVerificationProtocol_Values returns all elements of the ContactMethodVerificationProtocol enum

func ContactProtocol_Values added in v1.34.3 

func ContactProtocol_Values() []string

ContactProtocol_Values returns all elements of the ContactProtocol enum

func ContainerServiceDeploymentState_Values added in v1.35.27 

func ContainerServiceDeploymentState_Values() []string

ContainerServiceDeploymentState_Values returns all elements of the ContainerServiceDeploymentState enum

func ContainerServiceMetricName_Values added in v1.35.27 

func ContainerServiceMetricName_Values() []string

ContainerServiceMetricName_Values returns all elements of the ContainerServiceMetricName enum

func ContainerServicePowerName_Values added in v1.35.27 

func ContainerServicePowerName_Values() []string

ContainerServicePowerName_Values returns all elements of the ContainerServicePowerName enum

func ContainerServiceProtocol_Values added in v1.35.27 

func ContainerServiceProtocol_Values() []string

ContainerServiceProtocol_Values returns all elements of the ContainerServiceProtocol enum

func ContainerServiceStateDetailCode_Values added in v1.38.11 

func ContainerServiceStateDetailCode_Values() []string

ContainerServiceStateDetailCode_Values returns all elements of the ContainerServiceStateDetailCode enum

func ContainerServiceState_Values added in v1.35.27 

func ContainerServiceState_Values() []string

ContainerServiceState_Values returns all elements of the ContainerServiceState enum

func DiskSnapshotState_Values added in v1.34.3 

func DiskSnapshotState_Values() []string

DiskSnapshotState_Values returns all elements of the DiskSnapshotState enum

func DiskState_Values added in v1.34.3 

func DiskState_Values() []string

DiskState_Values returns all elements of the DiskState enum

func DistributionMetricName_Values added in v1.34.3 

func DistributionMetricName_Values() []string

DistributionMetricName_Values returns all elements of the DistributionMetricName enum

func DnsRecordCreationStateCode_Values added in v1.44.133 

func DnsRecordCreationStateCode_Values() []string

DnsRecordCreationStateCode_Values returns all elements of the DnsRecordCreationStateCode enum

func ExportSnapshotRecordSourceType_Values added in v1.34.3 

func ExportSnapshotRecordSourceType_Values() []string

ExportSnapshotRecordSourceType_Values returns all elements of the ExportSnapshotRecordSourceType enum

func ForwardValues_Values added in v1.34.3 

func ForwardValues_Values() []string

ForwardValues_Values returns all elements of the ForwardValues enum

func HeaderEnum_Values added in v1.34.3 

func HeaderEnum_Values() []string

HeaderEnum_Values returns all elements of the HeaderEnum enum

func HttpEndpoint_Values added in v1.44.105 

func HttpEndpoint_Values() []string

HttpEndpoint_Values returns all elements of the HttpEndpoint enum

func HttpProtocolIpv6_Values added in v1.44.105 

func HttpProtocolIpv6_Values() []string

HttpProtocolIpv6_Values returns all elements of the HttpProtocolIpv6 enum

func HttpTokens_Values added in v1.44.105 

func HttpTokens_Values() []string

HttpTokens_Values returns all elements of the HttpTokens enum

func InstanceAccessProtocol_Values added in v1.34.3 

func InstanceAccessProtocol_Values() []string

InstanceAccessProtocol_Values returns all elements of the InstanceAccessProtocol enum

func InstanceHealthReason_Values added in v1.34.3 

func InstanceHealthReason_Values() []string

InstanceHealthReason_Values returns all elements of the InstanceHealthReason enum

func InstanceHealthState_Values added in v1.34.3 

func InstanceHealthState_Values() []string

InstanceHealthState_Values returns all elements of the InstanceHealthState enum

func InstanceMetadataState_Values added in v1.44.105 

func InstanceMetadataState_Values() []string

InstanceMetadataState_Values returns all elements of the InstanceMetadataState enum

func InstanceMetricName_Values added in v1.34.3 

func InstanceMetricName_Values() []string

InstanceMetricName_Values returns all elements of the InstanceMetricName enum

func InstancePlatform_Values added in v1.34.3 

func InstancePlatform_Values() []string

InstancePlatform_Values returns all elements of the InstancePlatform enum

func InstanceSnapshotState_Values added in v1.34.3 

func InstanceSnapshotState_Values() []string

InstanceSnapshotState_Values returns all elements of the InstanceSnapshotState enum

func IpAddressType_Values added in v1.36.25 

func IpAddressType_Values() []string

IpAddressType_Values returns all elements of the IpAddressType enum

func LoadBalancerAttributeName_Values added in v1.34.3 

func LoadBalancerAttributeName_Values() []string

LoadBalancerAttributeName_Values returns all elements of the LoadBalancerAttributeName enum

func LoadBalancerMetricName_Values added in v1.34.3 

func LoadBalancerMetricName_Values() []string

LoadBalancerMetricName_Values returns all elements of the LoadBalancerMetricName enum

func LoadBalancerProtocol_Values added in v1.34.3 

func LoadBalancerProtocol_Values() []string

LoadBalancerProtocol_Values returns all elements of the LoadBalancerProtocol enum

func LoadBalancerState_Values added in v1.34.3 

func LoadBalancerState_Values() []string

LoadBalancerState_Values returns all elements of the LoadBalancerState enum

func LoadBalancerTlsCertificateDnsRecordCreationStateCode_Values added in v1.44.133 

func LoadBalancerTlsCertificateDnsRecordCreationStateCode_Values() []string

LoadBalancerTlsCertificateDnsRecordCreationStateCode_Values returns all elements of the LoadBalancerTlsCertificateDnsRecordCreationStateCode enum

func LoadBalancerTlsCertificateDomainStatus_Values added in v1.34.3 

func LoadBalancerTlsCertificateDomainStatus_Values() []string

LoadBalancerTlsCertificateDomainStatus_Values returns all elements of the LoadBalancerTlsCertificateDomainStatus enum

func LoadBalancerTlsCertificateFailureReason_Values added in v1.34.3 

func LoadBalancerTlsCertificateFailureReason_Values() []string

LoadBalancerTlsCertificateFailureReason_Values returns all elements of the LoadBalancerTlsCertificateFailureReason enum

func LoadBalancerTlsCertificateRenewalStatus_Values added in v1.34.3 

func LoadBalancerTlsCertificateRenewalStatus_Values() []string

LoadBalancerTlsCertificateRenewalStatus_Values returns all elements of the LoadBalancerTlsCertificateRenewalStatus enum

func LoadBalancerTlsCertificateRevocationReason_Values added in v1.34.3 

func LoadBalancerTlsCertificateRevocationReason_Values() []string

LoadBalancerTlsCertificateRevocationReason_Values returns all elements of the LoadBalancerTlsCertificateRevocationReason enum

func LoadBalancerTlsCertificateStatus_Values added in v1.34.3 

func LoadBalancerTlsCertificateStatus_Values() []string

LoadBalancerTlsCertificateStatus_Values returns all elements of the LoadBalancerTlsCertificateStatus enum

func MetricName_Values added in v1.34.3 

func MetricName_Values() []string

MetricName_Values returns all elements of the MetricName enum

func MetricStatistic_Values added in v1.34.3 

func MetricStatistic_Values() []string

MetricStatistic_Values returns all elements of the MetricStatistic enum

func MetricUnit_Values added in v1.34.3 

func MetricUnit_Values() []string

MetricUnit_Values returns all elements of the MetricUnit enum

func NameServersUpdateStateCode_Values added in v1.44.133 

func NameServersUpdateStateCode_Values() []string

NameServersUpdateStateCode_Values returns all elements of the NameServersUpdateStateCode enum

func NetworkProtocol_Values added in v1.34.3 

func NetworkProtocol_Values() []string

NetworkProtocol_Values returns all elements of the NetworkProtocol enum

func OperationStatus_Values added in v1.34.3 

func OperationStatus_Values() []string

OperationStatus_Values returns all elements of the OperationStatus enum

func OperationType_Values added in v1.34.3 

func OperationType_Values() []string

OperationType_Values returns all elements of the OperationType enum

func OriginProtocolPolicyEnum_Values added in v1.34.3 

func OriginProtocolPolicyEnum_Values() []string

OriginProtocolPolicyEnum_Values returns all elements of the OriginProtocolPolicyEnum enum

func PortAccessType_Values added in v1.34.3 

func PortAccessType_Values() []string

PortAccessType_Values returns all elements of the PortAccessType enum

func PortInfoSourceType_Values added in v1.34.3 

func PortInfoSourceType_Values() []string

PortInfoSourceType_Values returns all elements of the PortInfoSourceType enum

func PortState_Values added in v1.34.3 

func PortState_Values() []string

PortState_Values returns all elements of the PortState enum

func R53HostedZoneDeletionStateCode_Values added in v1.44.133 

func R53HostedZoneDeletionStateCode_Values() []string

R53HostedZoneDeletionStateCode_Values returns all elements of the R53HostedZoneDeletionStateCode enum

func RecordState_Values added in v1.34.3 

func RecordState_Values() []string

RecordState_Values returns all elements of the RecordState enum

func RegionName_Values added in v1.34.3 

func RegionName_Values() []string

RegionName_Values returns all elements of the RegionName enum

func RelationalDatabaseEngine_Values added in v1.34.3 

func RelationalDatabaseEngine_Values() []string

RelationalDatabaseEngine_Values returns all elements of the RelationalDatabaseEngine enum

func RelationalDatabaseMetricName_Values added in v1.34.3 

func RelationalDatabaseMetricName_Values() []string

RelationalDatabaseMetricName_Values returns all elements of the RelationalDatabaseMetricName enum

func RelationalDatabasePasswordVersion_Values added in v1.34.3 

func RelationalDatabasePasswordVersion_Values() []string

RelationalDatabasePasswordVersion_Values returns all elements of the RelationalDatabasePasswordVersion enum

func RenewalStatus_Values added in v1.34.3 

func RenewalStatus_Values() []string

RenewalStatus_Values returns all elements of the RenewalStatus enum

func ResourceBucketAccess_Values added in v1.40.0 

func ResourceBucketAccess_Values() []string

ResourceBucketAccess_Values returns all elements of the ResourceBucketAccess enum

func ResourceType_Values added in v1.34.3 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func StatusType_Values added in v1.40.0 

func StatusType_Values() []string

StatusType_Values returns all elements of the StatusType enum

func TreatMissingData_Values added in v1.34.3 

func TreatMissingData_Values() []string

TreatMissingData_Values returns all elements of the TreatMissingData enum

Types

type AccessDeniedException added in v1.28.0 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"code" type:"string"`

	Docs *string `locationName:"docs" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	Tip *string `locationName:"tip" type:"string"`
	// contains filtered or unexported fields
}

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessKey added in v1.40.0 

type AccessKey struct {

	// The ID of the access key.
	//
	// AccessKeyId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AccessKey's
	// String and GoString methods.
	AccessKeyId *string `locationName:"accessKeyId" min:"20" type:"string" sensitive:"true"`

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

	// An object that describes the last time the access key was used.
	//
	// This object does not include data in the response of a CreateBucketAccessKey
	// (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html)
	// action. If the access key has not been used, the region and serviceName values
	// are N/A, and the lastUsedDate value is null.
	LastUsed *AccessKeyLastUsed `locationName:"lastUsed" type:"structure"`

	// The secret access key used to sign requests.
	//
	// You should store the secret access key in a safe location. We recommend that
	// you delete the access key if the secret access key is compromised.
	SecretAccessKey *string `locationName:"secretAccessKey" type:"string"`

	// The status of the access key.
	//
	// A status of Active means that the key is valid, while Inactive means it is
	// not.
	Status *string `locationName:"status" type:"string" enum:"StatusType"`
	// contains filtered or unexported fields
}

Describes an access key for an Amazon Lightsail bucket.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) action to create an access key for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

func (AccessKey) GoString added in v1.40.0 

func (s AccessKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessKey) SetAccessKeyId added in v1.40.0 

func (s *AccessKey) SetAccessKeyId(v string) *AccessKey

SetAccessKeyId sets the AccessKeyId field's value.

func (*AccessKey) SetCreatedAt added in v1.40.0 

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

SetCreatedAt sets the CreatedAt field's value.

func (*AccessKey) SetLastUsed added in v1.40.17 

func (s *AccessKey) SetLastUsed(v *AccessKeyLastUsed) *AccessKey

SetLastUsed sets the LastUsed field's value.

func (*AccessKey) SetSecretAccessKey added in v1.40.0 

func (s *AccessKey) SetSecretAccessKey(v string) *AccessKey

SetSecretAccessKey sets the SecretAccessKey field's value.

func (*AccessKey) SetStatus added in v1.40.0 

func (s *AccessKey) SetStatus(v string) *AccessKey

SetStatus sets the Status field's value.

func (AccessKey) String added in v1.40.0 

func (s AccessKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessKeyLastUsed added in v1.40.17 

type AccessKeyLastUsed struct {

	// The date and time when the access key was most recently used.
	//
	// This value is null if the access key has not been used.
	LastUsedDate *time.Time `locationName:"lastUsedDate" type:"timestamp"`

	// The Amazon Web Services Region where this access key was most recently used.
	//
	// This value is N/A if the access key has not been used.
	Region *string `locationName:"region" type:"string"`

	// The name of the Amazon Web Services service with which this access key was
	// most recently used.
	//
	// This value is N/A if the access key has not been used.
	ServiceName *string `locationName:"serviceName" type:"string"`
	// contains filtered or unexported fields
}

Describes the last time an access key was used.

This object does not include data in the response of a CreateBucketAccessKey (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) action.

func (AccessKeyLastUsed) GoString added in v1.40.17 

func (s AccessKeyLastUsed) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessKeyLastUsed) SetLastUsedDate added in v1.40.17 

func (s *AccessKeyLastUsed) SetLastUsedDate(v time.Time) *AccessKeyLastUsed

SetLastUsedDate sets the LastUsedDate field's value.

func (*AccessKeyLastUsed) SetRegion added in v1.40.17 

func (s *AccessKeyLastUsed) SetRegion(v string) *AccessKeyLastUsed

SetRegion sets the Region field's value.

func (*AccessKeyLastUsed) SetServiceName added in v1.40.17 

func (s *AccessKeyLastUsed) SetServiceName(v string) *AccessKeyLastUsed

SetServiceName sets the ServiceName field's value.

func (AccessKeyLastUsed) String added in v1.40.17 

func (s AccessKeyLastUsed) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessRules added in v1.40.0 

type AccessRules struct {

	// A Boolean value that indicates whether the access control list (ACL) permissions
	// that are applied to individual objects override the getObject option that
	// is currently specified.
	//
	// When this is true, you can use the PutObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html)
	// Amazon S3 API action to set individual objects to public (read-only) using
	// the public-read ACL, or to private using the private ACL.
	AllowPublicOverrides *bool `locationName:"allowPublicOverrides" type:"boolean"`

	// Specifies the anonymous access to all objects in a bucket.
	//
	// The following options can be specified:
	//
	//    * public - Sets all objects in the bucket to public (read-only), making
	//    them readable by anyone in the world. If the getObject value is set to
	//    public, then all objects in the bucket default to public regardless of
	//    the allowPublicOverrides value.
	//
	//    * private - Sets all objects in the bucket to private, making them readable
	//    only by you or anyone you give access to. If the getObject value is set
	//    to private, and the allowPublicOverrides value is set to true, then all
	//    objects in the bucket default to private unless they are configured with
	//    a public-read ACL. Individual objects with a public-read ACL are readable
	//    by anyone in the world.
	GetObject *string `locationName:"getObject" type:"string" enum:"AccessType"`
	// contains filtered or unexported fields
}

Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects.

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-understanding-bucket-permissions) in the

Amazon Lightsail Developer Guide.

func (AccessRules) GoString added in v1.40.0 

func (s AccessRules) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessRules) SetAllowPublicOverrides added in v1.40.0 

func (s *AccessRules) SetAllowPublicOverrides(v bool) *AccessRules

SetAllowPublicOverrides sets the AllowPublicOverrides field's value.

func (*AccessRules) SetGetObject added in v1.40.0 

func (s *AccessRules) SetGetObject(v string) *AccessRules

SetGetObject sets the GetObject field's value.

func (AccessRules) String added in v1.40.0 

func (s AccessRules) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountLevelBpaSync added in v1.43.41 

type AccountLevelBpaSync struct {

	// A Boolean value that indicates whether account-level block public access
	// is affecting your Lightsail buckets.
	BpaImpactsLightsail *bool `locationName:"bpaImpactsLightsail" type:"boolean"`

	// The timestamp of when the account-level BPA configuration was last synchronized.
	// This value is null when the account-level BPA configuration has not been
	// synchronized.
	LastSyncedAt *time.Time `locationName:"lastSyncedAt" type:"timestamp"`

	// A message that provides a reason for a Failed or Defaulted synchronization
	// status.
	//
	// The following messages are possible:
	//
	//    * SYNC_ON_HOLD - The synchronization has not yet happened. This status
	//    message occurs immediately after you create your first Lightsail bucket.
	//    This status message should change after the first synchronization happens,
	//    approximately 1 hour after the first bucket is created.
	//
	//    * DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required
	//    service-linked role is missing from your Amazon Web Services account.
	//    The account-level BPA configuration for your Lightsail buckets is defaulted
	//    to active until the synchronization can occur. This means that all your
	//    buckets are private and not publicly accessible. For more information
	//    about how to create the required service-linked role to allow synchronization,
	//    see Using Service-Linked Roles for Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles)
	//    in the Amazon Lightsail Developer Guide.
	//
	//    * DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because
	//    the required service-linked role is missing from your Amazon Web Services
	//    account. Account-level BPA is not yet configured for your Lightsail buckets.
	//    Therefore, only the bucket access permissions and individual object access
	//    permissions apply to your Lightsail buckets. For more information about
	//    how to create the required service-linked role to allow synchronization,
	//    see Using Service-Linked Roles for Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles)
	//    in the Amazon Lightsail Developer Guide.
	//
	//    * Unknown - The reason that synchronization failed is unknown. Contact
	//    Amazon Web Services Support for more information.
	Message *string `locationName:"message" type:"string" enum:"BPAStatusMessage"`

	// The status of the account-level BPA synchronization.
	//
	// The following statuses are possible:
	//
	//    * InSync - Account-level BPA is synchronized. The Amazon S3 account-level
	//    BPA configuration applies to your Lightsail buckets.
	//
	//    * NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level
	//    BPA configuration does not apply to your Lightsail buckets.
	//
	//    * Failed - Synchronization failed. The Amazon S3 account-level BPA configuration
	//    does not apply to your Lightsail buckets.
	//
	//    * Defaulted - Synchronization failed and account-level BPA for your Lightsail
	//    buckets is defaulted to active.
	//
	// You might need to complete further actions if the status is Failed or Defaulted.
	// The message parameter provides more information for those statuses.
	Status *string `locationName:"status" type:"string" enum:"AccountLevelBpaSyncStatus"`
	// contains filtered or unexported fields
}

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access (BPA) feature for your Lightsail buckets.

The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets) in the Amazon Lightsail Developer Guide.

func (AccountLevelBpaSync) GoString added in v1.43.41 

func (s AccountLevelBpaSync) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountLevelBpaSync) SetBpaImpactsLightsail added in v1.43.41 

func (s *AccountLevelBpaSync) SetBpaImpactsLightsail(v bool) *AccountLevelBpaSync

SetBpaImpactsLightsail sets the BpaImpactsLightsail field's value.

func (*AccountLevelBpaSync) SetLastSyncedAt added in v1.43.41 

func (s *AccountLevelBpaSync) SetLastSyncedAt(v time.Time) *AccountLevelBpaSync

SetLastSyncedAt sets the LastSyncedAt field's value.

func (*AccountLevelBpaSync) SetMessage added in v1.43.41 

func (s *AccountLevelBpaSync) SetMessage(v string) *AccountLevelBpaSync

SetMessage sets the Message field's value.

func (*AccountLevelBpaSync) SetStatus added in v1.43.41 

func (s *AccountLevelBpaSync) SetStatus(v string) *AccountLevelBpaSync

SetStatus sets the Status field's value.

func (AccountLevelBpaSync) String added in v1.43.41 

func (s AccountLevelBpaSync) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountSetupInProgressException added in v1.28.0 

type AccountSetupInProgressException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"code" type:"string"`

	Docs *string `locationName:"docs" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	Tip *string `locationName:"tip" type:"string"`
	// contains filtered or unexported fields
}

Lightsail throws this exception when an account is still in the setup in progress state.

func (*AccountSetupInProgressException) Code added in v1.28.0 

func (s *AccountSetupInProgressException) Code() string

Code returns the exception type name.

func (*AccountSetupInProgressException) Error added in v1.28.0 

func (s *AccountSetupInProgressException) Error() string

func (AccountSetupInProgressException) GoString added in v1.28.0 

func (s AccountSetupInProgressException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountSetupInProgressException) Message added in v1.28.0 

func (s *AccountSetupInProgressException) Message() string

Message returns the exception's message.

func (*AccountSetupInProgressException) OrigErr added in v1.28.0 

func (s *AccountSetupInProgressException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccountSetupInProgressException) RequestID added in v1.28.0 

func (s *AccountSetupInProgressException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccountSetupInProgressException) StatusCode added in v1.28.0 

func (s *AccountSetupInProgressException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccountSetupInProgressException) String added in v1.28.0 

func (s AccountSetupInProgressException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddOn added in v1.25.4 

type AddOn struct {

	// The name of the add-on.
	Name *string `locationName:"name" type:"string"`

	// The next daily time an automatic snapshot will be created.
	//
	// The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
	//
	// The snapshot is automatically created between the time shown and up to 45
	// minutes after.
	NextSnapshotTimeOfDay *string `locationName:"nextSnapshotTimeOfDay" type:"string"`

	// The daily time when an automatic snapshot is created.
	//
	// The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
	//
	// The snapshot is automatically created between the time shown and up to 45
	// minutes after.
	SnapshotTimeOfDay *string `locationName:"snapshotTimeOfDay" type:"string"`

	// The status of the add-on.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

Describes an add-on that is enabled for an Amazon Lightsail resource.

func (AddOn) GoString added in v1.25.4 

func (s AddOn) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddOn) SetName added in v1.25.4 

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

SetName sets the Name field's value.

func (*AddOn) SetNextSnapshotTimeOfDay added in v1.25.4 

func (s *AddOn) SetNextSnapshotTimeOfDay(v string) *AddOn

SetNextSnapshotTimeOfDay sets the NextSnapshotTimeOfDay field's value.

func (*AddOn) SetSnapshotTimeOfDay added in v1.25.4 

func (s *AddOn) SetSnapshotTimeOfDay(v string) *AddOn

SetSnapshotTimeOfDay sets the SnapshotTimeOfDay field's value.

func (*AddOn) SetStatus added in v1.25.4 

func (s *AddOn) SetStatus(v string) *AddOn

SetStatus sets the Status field's value.

func (AddOn) String added in v1.25.4 

func (s AddOn) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AddOnRequest added in v1.25.4 

type AddOnRequest struct {

	// The add-on type.
	//
	// AddOnType is a required field
	AddOnType *string `locationName:"addOnType" type:"string" required:"true" enum:"AddOnType"`

	// An object that represents additional parameters when enabling or modifying
	// the automatic snapshot add-on.
	AutoSnapshotAddOnRequest *AutoSnapshotAddOnRequest `locationName:"autoSnapshotAddOnRequest" type:"structure"`
	// contains filtered or unexported fields
}

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page (https://aws.amazon.com/lightsail/pricing/).

func (AddOnRequest) GoString added in v1.25.4 

func (s AddOnRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddOnRequest) SetAddOnType added in v1.25.4 

func (s *AddOnRequest) SetAddOnType(v string) *AddOnRequest

SetAddOnType sets the AddOnType field's value.

func (*AddOnRequest) SetAutoSnapshotAddOnRequest added in v1.25.4 

func (s *AddOnRequest) SetAutoSnapshotAddOnRequest(v *AutoSnapshotAddOnRequest) *AddOnRequest

SetAutoSnapshotAddOnRequest sets the AutoSnapshotAddOnRequest field's value.

func (AddOnRequest) String added in v1.25.4 

func (s AddOnRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddOnRequest) Validate added in v1.25.4 

func (s *AddOnRequest) Validate() error

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

type Alarm added in v1.29.12 

type Alarm struct {

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

	// The arithmetic operation used when comparing the specified statistic and
	// threshold.
	ComparisonOperator *string `locationName:"comparisonOperator" type:"string" enum:"ComparisonOperator"`

	// The contact protocols for the alarm, such as Email, SMS (text messaging),
	// or both.
	ContactProtocols []*string `locationName:"contactProtocols" type:"list" enum:"ContactProtocol"`

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

	// The number of data points that must not within the specified threshold to
	// trigger the alarm.
	DatapointsToAlarm *int64 `locationName:"datapointsToAlarm" type:"integer"`

	// The number of periods over which data is compared to the specified threshold.
	EvaluationPeriods *int64 `locationName:"evaluationPeriods" type:"integer"`

	// An object that lists information about the location of the alarm.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the metric associated with the alarm.
	MetricName *string `locationName:"metricName" type:"string" enum:"MetricName"`

	// An object that lists information about the resource monitored by the alarm.
	MonitoredResourceInfo *MonitoredResourceInfo `locationName:"monitoredResourceInfo" type:"structure"`

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

	// Indicates whether the alarm is enabled.
	NotificationEnabled *bool `locationName:"notificationEnabled" type:"boolean"`

	// The alarm states that trigger a notification.
	NotificationTriggers []*string `locationName:"notificationTriggers" type:"list" enum:"AlarmState"`

	// The period, in seconds, over which the statistic is applied.
	Period *int64 `locationName:"period" min:"60" type:"integer"`

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

	// The current state of the alarm.
	//
	// An alarm has the following possible states:
	//
	//    * ALARM - The metric is outside of the defined threshold.
	//
	//    * INSUFFICIENT_DATA - The alarm has just started, the metric is not available,
	//    or not enough data is available for the metric to determine the alarm
	//    state.
	//
	//    * OK - The metric is within the defined threshold.
	State *string `locationName:"state" type:"string" enum:"AlarmState"`

	// The statistic for the metric associated with the alarm.
	//
	// The following statistics are available:
	//
	//    * Minimum - The lowest value observed during the specified period. Use
	//    this value to determine low volumes of activity for your application.
	//
	//    * Maximum - The highest value observed during the specified period. Use
	//    this value to determine high volumes of activity for your application.
	//
	//    * Sum - All values submitted for the matching metric added together. You
	//    can use this statistic to determine the total volume of a metric.
	//
	//    * Average - The value of Sum / SampleCount during the specified period.
	//    By comparing this statistic with the Minimum and Maximum values, you can
	//    determine the full scope of a metric and how close the average use is
	//    to the Minimum and Maximum values. This comparison helps you to know when
	//    to increase or decrease your resources.
	//
	//    * SampleCount - The count, or number, of data points used for the statistical
	//    calculation.
	Statistic *string `locationName:"statistic" type:"string" enum:"MetricStatistic"`

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

	// The value against which the specified statistic is compared.
	Threshold *float64 `locationName:"threshold" type:"double"`

	// Specifies how the alarm handles missing data points.
	//
	// An alarm can treat missing data in the following ways:
	//
	//    * breaching - Assume the missing data is not within the threshold. Missing
	//    data counts towards the number of times the metric is not within the threshold.
	//
	//    * notBreaching - Assume the missing data is within the threshold. Missing
	//    data does not count towards the number of times the metric is not within
	//    the threshold.
	//
	//    * ignore - Ignore the missing data. Maintains the current alarm state.
	//
	//    * missing - Missing data is treated as missing.
	TreatMissingData *string `locationName:"treatMissingData" type:"string" enum:"TreatMissingData"`

	// The unit of the metric associated with the alarm.
	Unit *string `locationName:"unit" type:"string" enum:"MetricUnit"`
	// contains filtered or unexported fields
}

Describes an alarm.

An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

func (Alarm) GoString added in v1.29.12 

func (s Alarm) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Alarm) SetArn added in v1.29.12 

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

SetArn sets the Arn field's value.

func (*Alarm) SetComparisonOperator added in v1.29.12 

func (s *Alarm) SetComparisonOperator(v string) *Alarm

SetComparisonOperator sets the ComparisonOperator field's value.

func (*Alarm) SetContactProtocols added in v1.29.12 

func (s *Alarm) SetContactProtocols(v []*string) *Alarm

SetContactProtocols sets the ContactProtocols field's value.

func (*Alarm) SetCreatedAt added in v1.29.12 

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

SetCreatedAt sets the CreatedAt field's value.

func (*Alarm) SetDatapointsToAlarm added in v1.29.12 

func (s *Alarm) SetDatapointsToAlarm(v int64) *Alarm

SetDatapointsToAlarm sets the DatapointsToAlarm field's value.

func (*Alarm) SetEvaluationPeriods added in v1.29.12 

func (s *Alarm) SetEvaluationPeriods(v int64) *Alarm

SetEvaluationPeriods sets the EvaluationPeriods field's value.

func (*Alarm) SetLocation added in v1.29.12 

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

SetLocation sets the Location field's value.

func (*Alarm) SetMetricName added in v1.29.12 

func (s *Alarm) SetMetricName(v string) *Alarm

SetMetricName sets the MetricName field's value.

func (*Alarm) SetMonitoredResourceInfo added in v1.29.12 

func (s *Alarm) SetMonitoredResourceInfo(v *MonitoredResourceInfo) *Alarm

SetMonitoredResourceInfo sets the MonitoredResourceInfo field's value.

func (*Alarm) SetName added in v1.29.12 

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

SetName sets the Name field's value.

func (*Alarm) SetNotificationEnabled added in v1.29.12 

func (s *Alarm) SetNotificationEnabled(v bool) *Alarm

SetNotificationEnabled sets the NotificationEnabled field's value.

func (*Alarm) SetNotificationTriggers added in v1.29.12 

func (s *Alarm) SetNotificationTriggers(v []*string) *Alarm

SetNotificationTriggers sets the NotificationTriggers field's value.

func (*Alarm) SetPeriod added in v1.29.12 

func (s *Alarm) SetPeriod(v int64) *Alarm

SetPeriod sets the Period field's value.

func (*Alarm) SetResourceType added in v1.29.12 

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

SetResourceType sets the ResourceType field's value.

func (*Alarm) SetState added in v1.29.12 

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

SetState sets the State field's value.

func (*Alarm) SetStatistic added in v1.29.12 

func (s *Alarm) SetStatistic(v string) *Alarm

SetStatistic sets the Statistic field's value.

func (*Alarm) SetSupportCode added in v1.29.12 

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

SetSupportCode sets the SupportCode field's value.

func (*Alarm) SetThreshold added in v1.29.12 

func (s *Alarm) SetThreshold(v float64) *Alarm

SetThreshold sets the Threshold field's value.

func (*Alarm) SetTreatMissingData added in v1.29.12 

func (s *Alarm) SetTreatMissingData(v string) *Alarm

SetTreatMissingData sets the TreatMissingData field's value.

func (*Alarm) SetUnit added in v1.29.12 

func (s *Alarm) SetUnit(v string) *Alarm

SetUnit sets the Unit field's value.

func (Alarm) String added in v1.29.12 

func (s Alarm) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AllocateStaticIpOutput) GoString 

func (s AllocateStaticIpOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AllocateStaticIpOutput) SetOperations 

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

SetOperations sets the Operations field's value.

func (AllocateStaticIpOutput) String 

func (s AllocateStaticIpOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachCertificateToDistributionInput added in v1.33.11 

type AttachCertificateToDistributionInput struct {

	// The name of the certificate to attach to a distribution.
	//
	// Only certificates with a status of ISSUED can be attached to a distribution.
	//
	// Use the GetCertificates action to get a list of certificate names that you
	// can specify.
	//
	// This is the name of the certificate resource type and is used only to reference
	// the certificate in other API actions. It can be different than the domain
	// name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate
	// and the domain name of the certificate might be example.com.
	//
	// CertificateName is a required field
	CertificateName *string `locationName:"certificateName" type:"string" required:"true"`

	// The name of the distribution that the certificate will be attached to.
	//
	// Use the GetDistributions action to get a list of distribution names that
	// you can specify.
	//
	// DistributionName is a required field
	DistributionName *string `locationName:"distributionName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AttachCertificateToDistributionInput) GoString added in v1.33.11 

func (s AttachCertificateToDistributionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachCertificateToDistributionInput) SetCertificateName added in v1.33.11 

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

SetCertificateName sets the CertificateName field's value.

func (*AttachCertificateToDistributionInput) SetDistributionName added in v1.33.11 

func (s *AttachCertificateToDistributionInput) SetDistributionName(v string) *AttachCertificateToDistributionInput

SetDistributionName sets the DistributionName field's value.

func (AttachCertificateToDistributionInput) String added in v1.33.11 

func (s AttachCertificateToDistributionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachCertificateToDistributionInput) Validate added in v1.33.11 

func (s *AttachCertificateToDistributionInput) Validate() error

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

type AttachCertificateToDistributionOutput added in v1.33.11 

type AttachCertificateToDistributionOutput struct {

	// An object that describes the result of the action, such as the status of
	// the request, the timestamp of the request, and the resources affected by
	// the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (AttachCertificateToDistributionOutput) GoString added in v1.33.11 

func (s AttachCertificateToDistributionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachCertificateToDistributionOutput) SetOperation added in v1.33.11 

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

SetOperation sets the Operation field's value.

func (AttachCertificateToDistributionOutput) String added in v1.33.11 

func (s AttachCertificateToDistributionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s AttachInstancesToLoadBalancerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachInstancesToLoadBalancerInput) SetInstanceNames added in v1.12.37 

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

SetInstanceNames sets the InstanceNames field's value.

func (*AttachInstancesToLoadBalancerInput) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (AttachInstancesToLoadBalancerInput) String added in v1.12.37 

func (s AttachInstancesToLoadBalancerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachInstancesToLoadBalancerInput) Validate added in v1.12.37 

func (s *AttachInstancesToLoadBalancerInput) Validate() error

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

type AttachInstancesToLoadBalancerOutput added in v1.12.37 

type AttachInstancesToLoadBalancerOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AttachInstancesToLoadBalancerOutput) GoString added in v1.12.37 

func (s AttachInstancesToLoadBalancerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachInstancesToLoadBalancerOutput) SetOperations added in v1.12.37 

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

SetOperations sets the Operations field's value.

func (AttachInstancesToLoadBalancerOutput) String added in v1.12.37 

func (s AttachInstancesToLoadBalancerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s AttachLoadBalancerTlsCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachLoadBalancerTlsCertificateInput) SetCertificateName added in v1.12.37 

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

SetCertificateName sets the CertificateName field's value.

func (*AttachLoadBalancerTlsCertificateInput) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (AttachLoadBalancerTlsCertificateInput) String added in v1.12.37 

func (s AttachLoadBalancerTlsCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachLoadBalancerTlsCertificateInput) Validate added in v1.12.37 

func (s *AttachLoadBalancerTlsCertificateInput) Validate() error

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

type AttachLoadBalancerTlsCertificateOutput added in v1.12.37 

type AttachLoadBalancerTlsCertificateOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	//
	// These SSL/TLS certificates are only usable by Lightsail load balancers. You
	// can't get the certificate and use it for another purpose.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AttachLoadBalancerTlsCertificateOutput) GoString added in v1.12.37 

func (s AttachLoadBalancerTlsCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachLoadBalancerTlsCertificateOutput) SetOperations added in v1.12.37 

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

SetOperations sets the Operations field's value.

func (AttachLoadBalancerTlsCertificateOutput) String added in v1.12.37 

func (s AttachLoadBalancerTlsCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (AttachStaticIpOutput) GoString 

func (s AttachStaticIpOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttachedDisk added in v1.25.4 

type AttachedDisk struct {

	// The path of the disk (e.g., /dev/xvdf).
	Path *string `locationName:"path" type:"string"`

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

Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.

func (AttachedDisk) GoString added in v1.25.4 

func (s AttachedDisk) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttachedDisk) SetPath added in v1.25.4 

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

SetPath sets the Path field's value.

func (*AttachedDisk) SetSizeInGb added in v1.25.4 

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

SetSizeInGb sets the SizeInGb field's value.

func (AttachedDisk) String added in v1.25.4 

func (s AttachedDisk) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoSnapshotAddOnRequest added in v1.25.4 

type AutoSnapshotAddOnRequest struct {

	// The daily time when an automatic snapshot will be created.
	//
	// Constraints:
	//
	//    * Must be in HH:00 format, and in an hourly increment.
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * The snapshot will be automatically created between the time specified
	//    and up to 45 minutes after.
	SnapshotTimeOfDay *string `locationName:"snapshotTimeOfDay" type:"string"`
	// contains filtered or unexported fields
}

Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk.

When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions:

  • If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day.

  • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day.

  • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

  • If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

func (AutoSnapshotAddOnRequest) GoString added in v1.25.4 

func (s AutoSnapshotAddOnRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoSnapshotAddOnRequest) SetSnapshotTimeOfDay added in v1.25.4 

func (s *AutoSnapshotAddOnRequest) SetSnapshotTimeOfDay(v string) *AutoSnapshotAddOnRequest

SetSnapshotTimeOfDay sets the SnapshotTimeOfDay field's value.

func (AutoSnapshotAddOnRequest) String added in v1.25.4 

func (s AutoSnapshotAddOnRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoSnapshotDetails added in v1.25.4 

type AutoSnapshotDetails struct {

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

	// The date of the automatic snapshot in YYYY-MM-DD format.
	Date *string `locationName:"date" type:"string"`

	// An array of objects that describe the block storage disks attached to the
	// instance when the automatic snapshot was created.
	FromAttachedDisks []*AttachedDisk `locationName:"fromAttachedDisks" type:"list"`

	// The status of the automatic snapshot.
	Status *string `locationName:"status" type:"string" enum:"AutoSnapshotStatus"`
	// contains filtered or unexported fields
}

Describes an automatic snapshot.

func (AutoSnapshotDetails) GoString added in v1.25.4 

func (s AutoSnapshotDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoSnapshotDetails) SetCreatedAt added in v1.25.4 

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

SetCreatedAt sets the CreatedAt field's value.

func (*AutoSnapshotDetails) SetDate added in v1.25.4 

func (s *AutoSnapshotDetails) SetDate(v string) *AutoSnapshotDetails

SetDate sets the Date field's value.

func (*AutoSnapshotDetails) SetFromAttachedDisks added in v1.25.4 

func (s *AutoSnapshotDetails) SetFromAttachedDisks(v []*AttachedDisk) *AutoSnapshotDetails

SetFromAttachedDisks sets the FromAttachedDisks field's value.

func (*AutoSnapshotDetails) SetStatus added in v1.25.4 

func (s *AutoSnapshotDetails) SetStatus(v string) *AutoSnapshotDetails

SetStatus sets the Status field's value.

func (AutoSnapshotDetails) String added in v1.25.4 

func (s AutoSnapshotDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Bucket added in v1.40.0 

type Bucket struct {

	// Indicates whether the bundle that is currently applied to a bucket can be
	// changed to another bundle.
	//
	// You can update a bucket's bundle only one time within a monthly Amazon Web
	// Services billing cycle.
	//
	// Use the UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html)
	// action to change a bucket's bundle.
	AbleToUpdateBundle *bool `locationName:"ableToUpdateBundle" type:"boolean"`

	// An object that describes the access log configuration for the bucket.
	AccessLogConfig *BucketAccessLogConfig `locationName:"accessLogConfig" type:"structure"`

	// An object that describes the access rules of the bucket.
	AccessRules *AccessRules `locationName:"accessRules" type:"structure"`

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

	// The ID of the bundle currently applied to the bucket.
	//
	// A bucket bundle specifies the monthly cost, storage space, and data transfer
	// quota for a bucket.
	//
	// Use the UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html)
	// action to change the bundle of a bucket.
	BundleId *string `locationName:"bundleId" type:"string"`

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

	// An object that describes the location of the bucket, such as the Amazon Web
	// Services Region and Availability Zone.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// The name of the bucket.
	Name *string `locationName:"name" min:"3" type:"string"`

	// Indicates whether object versioning is enabled for the bucket.
	//
	// The following options can be configured:
	//
	//    * Enabled - Object versioning is enabled.
	//
	//    * Suspended - Object versioning was previously enabled but is currently
	//    suspended. Existing object versions are retained.
	//
	//    * NeverEnabled - Object versioning has never been enabled.
	ObjectVersioning *string `locationName:"objectVersioning" type:"string"`

	// An array of strings that specify the Amazon Web Services account IDs that
	// have read-only access to the bucket.
	ReadonlyAccessAccounts []*string `locationName:"readonlyAccessAccounts" type:"list"`

	// The Lightsail resource type of the bucket (for example, Bucket).
	ResourceType *string `locationName:"resourceType" type:"string"`

	// An array of objects that describe Lightsail instances that have access to
	// the bucket.
	//
	// Use the SetResourceAccessForBucket (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html)
	// action to update the instances that have access to a bucket.
	ResourcesReceivingAccess []*ResourceReceivingAccess `locationName:"resourcesReceivingAccess" type:"list"`

	// An object that describes the state of the bucket.
	State *BucketState `locationName:"state" type:"structure"`

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

	// The tag keys and optional values for the bucket. For more information, see
	// Tags in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags)
	// in the Amazon Lightsail Developer Guide.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The URL of the bucket.
	Url *string `locationName:"url" type:"string"`
	// contains filtered or unexported fields
}

Describes an Amazon Lightsail bucket.

func (Bucket) GoString added in v1.40.0 

func (s Bucket) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Bucket) SetAbleToUpdateBundle added in v1.40.0 

func (s *Bucket) SetAbleToUpdateBundle(v bool) *Bucket

SetAbleToUpdateBundle sets the AbleToUpdateBundle field's value.

func (*Bucket) SetAccessLogConfig added in v1.41.15 

func (s *Bucket) SetAccessLogConfig(v *BucketAccessLogConfig) *Bucket

SetAccessLogConfig sets the AccessLogConfig field's value.

func (*Bucket) SetAccessRules added in v1.40.0 

func (s *Bucket) SetAccessRules(v *AccessRules) *Bucket

SetAccessRules sets the AccessRules field's value.

func (*Bucket) SetArn added in v1.40.0 

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

SetArn sets the Arn field's value.

func (*Bucket) SetBundleId added in v1.40.0 

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

SetBundleId sets the BundleId field's value.

func (*Bucket) SetCreatedAt added in v1.40.0 

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

SetCreatedAt sets the CreatedAt field's value.

func (*Bucket) SetLocation added in v1.40.0 

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

SetLocation sets the Location field's value.

func (*Bucket) SetName added in v1.40.0 

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

SetName sets the Name field's value.

func (*Bucket) SetObjectVersioning added in v1.40.0 

func (s *Bucket) SetObjectVersioning(v string) *Bucket

SetObjectVersioning sets the ObjectVersioning field's value.

func (*Bucket) SetReadonlyAccessAccounts added in v1.40.0 

func (s *Bucket) SetReadonlyAccessAccounts(v []*string) *Bucket

SetReadonlyAccessAccounts sets the ReadonlyAccessAccounts field's value.

func (*Bucket) SetResourceType added in v1.40.0 

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

SetResourceType sets the ResourceType field's value.

func (*Bucket) SetResourcesReceivingAccess added in v1.40.0 

func (s *Bucket) SetResourcesReceivingAccess(v []*ResourceReceivingAccess) *Bucket

SetResourcesReceivingAccess sets the ResourcesReceivingAccess field's value.

func (*Bucket) SetState added in v1.40.0 

func (s *Bucket) SetState(v *BucketState) *Bucket

SetState sets the State field's value.

func (*Bucket) SetSupportCode added in v1.40.0 

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

SetSupportCode sets the SupportCode field's value.

func (*Bucket) SetTags added in v1.40.0 

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

SetTags sets the Tags field's value.

func (*Bucket) SetUrl added in v1.40.0 

func (s *Bucket) SetUrl(v string) *Bucket

SetUrl sets the Url field's value.

func (Bucket) String added in v1.40.0 

func (s Bucket) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BucketAccessLogConfig added in v1.41.15 

type BucketAccessLogConfig struct {

	// The name of the bucket where the access logs are saved. The destination can
	// be a Lightsail bucket in the same account, and in the same Amazon Web Services
	// Region as the source bucket.
	//
	// This parameter is required when enabling the access log for a bucket, and
	// should be omitted when disabling the access log.
	Destination *string `locationName:"destination" min:"3" type:"string"`

	// A Boolean value that indicates whether bucket access logging is enabled for
	// the bucket.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`

	// The optional object prefix for the bucket access log.
	//
	// The prefix is an optional addition to the object key that organizes your
	// access log files in the destination bucket. For example, if you specify a
	// logs/ prefix, then each log object will begin with the logs/ prefix in its
	// key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).
	//
	// This parameter can be optionally specified when enabling the access log for
	// a bucket, and should be omitted when disabling the access log.
	Prefix *string `locationName:"prefix" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the access log configuration for a bucket in the Amazon Lightsail object storage service.

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-bucket-access-logs) in the Amazon Lightsail Developer Guide.

func (BucketAccessLogConfig) GoString added in v1.41.15 

func (s BucketAccessLogConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BucketAccessLogConfig) SetDestination added in v1.41.15 

func (s *BucketAccessLogConfig) SetDestination(v string) *BucketAccessLogConfig

SetDestination sets the Destination field's value.

func (*BucketAccessLogConfig) SetEnabled added in v1.41.15 

func (s *BucketAccessLogConfig) SetEnabled(v bool) *BucketAccessLogConfig

SetEnabled sets the Enabled field's value.

func (*BucketAccessLogConfig) SetPrefix added in v1.41.15 

func (s *BucketAccessLogConfig) SetPrefix(v string) *BucketAccessLogConfig

SetPrefix sets the Prefix field's value.

func (BucketAccessLogConfig) String added in v1.41.15 

func (s BucketAccessLogConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BucketAccessLogConfig) Validate added in v1.41.15 

func (s *BucketAccessLogConfig) Validate() error

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

type BucketBundle added in v1.40.0 

type BucketBundle struct {

	// The ID of the bundle.
	BundleId *string `locationName:"bundleId" type:"string"`

	// Indicates whether the bundle is active. Use for a new or existing bucket.
	IsActive *bool `locationName:"isActive" type:"boolean"`

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

	// The monthly price of the bundle, in US dollars.
	Price *float64 `locationName:"price" type:"float"`

	// The storage size of the bundle, in GB.
	StoragePerMonthInGb *int64 `locationName:"storagePerMonthInGb" type:"integer"`

	// The monthly network transfer quota of the bundle.
	TransferPerMonthInGb *int64 `locationName:"transferPerMonthInGb" type:"integer"`
	// contains filtered or unexported fields
}

Describes the specifications of a bundle that can be applied to an Amazon Lightsail bucket.

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

func (BucketBundle) GoString added in v1.40.0 

func (s BucketBundle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BucketBundle) SetBundleId added in v1.40.0 

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

SetBundleId sets the BundleId field's value.

func (*BucketBundle) SetIsActive added in v1.40.0 

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

SetIsActive sets the IsActive field's value.

func (*BucketBundle) SetName added in v1.40.0 

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

SetName sets the Name field's value.

func (*BucketBundle) SetPrice added in v1.40.0 

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

SetPrice sets the Price field's value.

func (*BucketBundle) SetStoragePerMonthInGb added in v1.40.0 

func (s *BucketBundle) SetStoragePerMonthInGb(v int64) *BucketBundle

SetStoragePerMonthInGb sets the StoragePerMonthInGb field's value.

func (*BucketBundle) SetTransferPerMonthInGb added in v1.40.0 

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

SetTransferPerMonthInGb sets the TransferPerMonthInGb field's value.

func (BucketBundle) String added in v1.40.0 

func (s BucketBundle) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BucketState added in v1.40.0 

type BucketState struct {

	// The state code of the bucket.
	//
	// The following codes are possible:
	//
	//    * OK - The bucket is in a running state.
	//
	//    * Unknown - Creation of the bucket might have timed-out. You might want
	//    to delete the bucket and create a new one.
	Code *string `locationName:"code" type:"string"`

	// A message that describes the state of the bucket.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Describes the state of an Amazon Lightsail bucket.

func (BucketState) GoString added in v1.40.0 

func (s BucketState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BucketState) SetCode added in v1.40.0 

func (s *BucketState) SetCode(v string) *BucketState

SetCode sets the Code field's value.

func (*BucketState) SetMessage added in v1.40.0 

func (s *BucketState) SetMessage(v string) *BucketState

SetMessage sets the Message field's value.

func (BucketState) String added in v1.40.0 

func (s BucketState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) of the bundle.
	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" enum:"InstancePlatform"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CacheBehavior added in v1.33.11 

type CacheBehavior struct {

	// The cache behavior of the distribution.
	//
	// The following cache behaviors can be specified:
	//
	//    * cache - This option is best for static sites. When specified, your distribution
	//    caches and serves your entire website as static content. This behavior
	//    is ideal for websites with static content that doesn't change depending
	//    on who views it, or for websites that don't use cookies, headers, or query
	//    strings to personalize content.
	//
	//    * dont-cache - This option is best for sites that serve a mix of static
	//    and dynamic content. When specified, your distribution caches and serve
	//    only the content that is specified in the distribution's CacheBehaviorPerPath
	//    parameter. This behavior is ideal for websites or web applications that
	//    use cookies, headers, and query strings to personalize content for individual
	//    users.
	Behavior *string `locationName:"behavior" type:"string" enum:"BehaviorEnum"`
	// contains filtered or unexported fields
}

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

func (CacheBehavior) GoString added in v1.33.11 

func (s CacheBehavior) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheBehavior) SetBehavior added in v1.33.11 

func (s *CacheBehavior) SetBehavior(v string) *CacheBehavior

SetBehavior sets the Behavior field's value.

func (CacheBehavior) String added in v1.33.11 

func (s CacheBehavior) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CacheBehaviorPerPath added in v1.33.11 

type CacheBehaviorPerPath struct {

	// The cache behavior for the specified path.
	//
	// You can specify one of the following per-path cache behaviors:
	//
	//    * cache - This behavior caches the specified path.
	//
	//    * dont-cache - This behavior doesn't cache the specified path.
	Behavior *string `locationName:"behavior" type:"string" enum:"BehaviorEnum"`

	// The path to a directory or file to cached, or not cache. Use an asterisk
	// symbol to specify wildcard directories (path/to/assets/*), and file types
	// (*.html, *jpg, *js). Directories and file paths are case-sensitive.
	//
	// Examples:
	//
	//    * Specify the following to cache all files in the document root of an
	//    Apache web server running on a Lightsail instance. var/www/html/
	//
	//    * Specify the following file to cache only the index page in the document
	//    root of an Apache web server. var/www/html/index.html
	//
	//    * Specify the following to cache only the .html files in the document
	//    root of an Apache web server. var/www/html/*.html
	//
	//    * Specify the following to cache only the .jpg, .png, and .gif files in
	//    the images sub-directory of the document root of an Apache web server.
	//    var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif
	//    Specify the following to cache all files in the images sub-directory of
	//    the document root of an Apache web server. var/www/html/images/
	Path *string `locationName:"path" type:"string"`
	// contains filtered or unexported fields
}

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

func (CacheBehaviorPerPath) GoString added in v1.33.11 

func (s CacheBehaviorPerPath) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheBehaviorPerPath) SetBehavior added in v1.33.11 

func (s *CacheBehaviorPerPath) SetBehavior(v string) *CacheBehaviorPerPath

SetBehavior sets the Behavior field's value.

func (*CacheBehaviorPerPath) SetPath added in v1.33.11 

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

SetPath sets the Path field's value.

func (CacheBehaviorPerPath) String added in v1.33.11 

func (s CacheBehaviorPerPath) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CacheSettings added in v1.33.11 

type CacheSettings struct {

	// The HTTP methods that are processed and forwarded to the distribution's origin.
	//
	// You can specify the following options:
	//
	//    * GET,HEAD - The distribution forwards the GET and HEAD methods.
	//
	//    * GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS
	//    methods.
	//
	//    * GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the
	//    GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.
	//
	// If you specify the third option, you might need to restrict access to your
	// distribution's origin so users can't perform operations that you don't want
	// them to. For example, you might not want users to have permission to delete
	// objects from your origin.
	AllowedHTTPMethods *string `locationName:"allowedHTTPMethods" type:"string"`

	// The HTTP method responses that are cached by your distribution.
	//
	// You can specify the following options:
	//
	//    * GET,HEAD - The distribution caches responses to the GET and HEAD methods.
	//
	//    * GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD,
	//    and OPTIONS methods.
	CachedHTTPMethods *string `locationName:"cachedHTTPMethods" type:"string"`

	// The default amount of time that objects stay in the distribution's cache
	// before the distribution forwards another request to the origin to determine
	// whether the content has been updated.
	//
	// The value specified applies only when the origin does not add HTTP headers
	// such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
	DefaultTTL *int64 `locationName:"defaultTTL" type:"long"`

	// An object that describes the cookies that are forwarded to the origin. Your
	// content is cached based on the cookies that are forwarded.
	ForwardedCookies *CookieObject `locationName:"forwardedCookies" type:"structure"`

	// An object that describes the headers that are forwarded to the origin. Your
	// content is cached based on the headers that are forwarded.
	ForwardedHeaders *HeaderObject `locationName:"forwardedHeaders" type:"structure"`

	// An object that describes the query strings that are forwarded to the origin.
	// Your content is cached based on the query strings that are forwarded.
	ForwardedQueryStrings *QueryStringObject `locationName:"forwardedQueryStrings" type:"structure"`

	// The maximum amount of time that objects stay in the distribution's cache
	// before the distribution forwards another request to the origin to determine
	// whether the object has been updated.
	//
	// The value specified applies only when the origin adds HTTP headers such as
	// Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
	MaximumTTL *int64 `locationName:"maximumTTL" type:"long"`

	// The minimum amount of time that objects stay in the distribution's cache
	// before the distribution forwards another request to the origin to determine
	// whether the object has been updated.
	//
	// A value of 0 must be specified for minimumTTL if the distribution is configured
	// to forward all headers to the origin.
	MinimumTTL *int64 `locationName:"minimumTTL" type:"long"`
	// contains filtered or unexported fields
}

Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.

These settings apply only to your distribution's cacheBehaviors (including the defaultCacheBehavior) that have a behavior of cache.

func (CacheSettings) GoString added in v1.33.11 

func (s CacheSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CacheSettings) SetAllowedHTTPMethods added in v1.33.11 

func (s *CacheSettings) SetAllowedHTTPMethods(v string) *CacheSettings

SetAllowedHTTPMethods sets the AllowedHTTPMethods field's value.

func (*CacheSettings) SetCachedHTTPMethods added in v1.33.11 

func (s *CacheSettings) SetCachedHTTPMethods(v string) *CacheSettings

SetCachedHTTPMethods sets the CachedHTTPMethods field's value.

func (*CacheSettings) SetDefaultTTL added in v1.33.11 

func (s *CacheSettings) SetDefaultTTL(v int64) *CacheSettings

SetDefaultTTL sets the DefaultTTL field's value.

func (*CacheSettings) SetForwardedCookies added in v1.33.11 

func (s *CacheSettings) SetForwardedCookies(v *CookieObject) *CacheSettings

SetForwardedCookies sets the ForwardedCookies field's value.

func (*CacheSettings) SetForwardedHeaders added in v1.33.11 

func (s *CacheSettings) SetForwardedHeaders(v *HeaderObject) *CacheSettings

SetForwardedHeaders sets the ForwardedHeaders field's value.

func (*CacheSettings) SetForwardedQueryStrings added in v1.33.11 

func (s *CacheSettings) SetForwardedQueryStrings(v *QueryStringObject) *CacheSettings

SetForwardedQueryStrings sets the ForwardedQueryStrings field's value.

func (*CacheSettings) SetMaximumTTL added in v1.33.11 

func (s *CacheSettings) SetMaximumTTL(v int64) *CacheSettings

SetMaximumTTL sets the MaximumTTL field's value.

func (*CacheSettings) SetMinimumTTL added in v1.33.11 

func (s *CacheSettings) SetMinimumTTL(v int64) *CacheSettings

SetMinimumTTL sets the MinimumTTL field's value.

func (CacheSettings) String added in v1.33.11 

func (s CacheSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Certificate added in v1.33.11 

type Certificate struct {

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

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

	// The domain name of the certificate.
	DomainName *string `locationName:"domainName" type:"string"`

	// An array of objects that describe the domain validation records of the certificate.
	DomainValidationRecords []*DomainValidationRecord `locationName:"domainValidationRecords" type:"list"`

	// The renewal eligibility of the certificate.
	EligibleToRenew *string `locationName:"eligibleToRenew" type:"string"`

	// The number of Lightsail resources that the certificate is attached to.
	InUseResourceCount *int64 `locationName:"inUseResourceCount" type:"integer"`

	// The timestamp when the certificate was issued.
	IssuedAt *time.Time `locationName:"issuedAt" type:"timestamp"`

	// The certificate authority that issued the certificate.
	IssuerCA *string `locationName:"issuerCA" type:"string"`

	// The algorithm used to generate the key pair (the public and private key)
	// of the certificate.
	KeyAlgorithm *string `locationName:"keyAlgorithm" type:"string"`

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

	// The timestamp when the certificate expires.
	NotAfter *time.Time `locationName:"notAfter" type:"timestamp"`

	// The timestamp when the certificate is first valid.
	NotBefore *time.Time `locationName:"notBefore" type:"timestamp"`

	// An object that describes the status of the certificate renewal managed by
	// Lightsail.
	RenewalSummary *RenewalSummary `locationName:"renewalSummary" type:"structure"`

	// The validation failure reason, if any, of the certificate.
	//
	// The following failure reasons are possible:
	//
	//    * NO_AVAILABLE_CONTACTS - This failure applies to email validation, which
	//    is not available for Lightsail certificates.
	//
	//    * ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information
	//    to process this certificate request. This can happen as a fraud-protection
	//    measure, such as when the domain ranks within the Alexa top 1000 websites.
	//    To provide the required information, use the Amazon Web Services Support
	//    Center (https://console.aws.amazon.com/support/home) to contact Amazon
	//    Web Services Support. You cannot request a certificate for Amazon-owned
	//    domain names such as those ending in amazonaws.com, cloudfront.net, or
	//    elasticbeanstalk.com.
	//
	//    * DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate
	//    request was reported as an unsafe domain by VirusTotal (https://www.virustotal.com/gui/home/url).
	//    To correct the problem, search for your domain name on the VirusTotal
	//    (https://www.virustotal.com/gui/home/url) website. If your domain is reported
	//    as suspicious, see Google Help for Hacked Websites (https://developers.google.com/web/fundamentals/security/hacked)
	//    to learn what you can do. If you believe that the result is a false positive,
	//    notify the organization that is reporting the domain. VirusTotal is an
	//    aggregate of several antivirus and URL scanners and cannot remove your
	//    domain from a block list itself. After you correct the problem and the
	//    VirusTotal registry has been updated, request a new certificate. If you
	//    see this error and your domain is not included in the VirusTotal list,
	//    visit the Amazon Web Services Support Center (https://console.aws.amazon.com/support/home)
	//    and create a case.
	//
	//    * INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate
	//    request is not valid. Typically, this is because a domain name in the
	//    request is not a valid top-level domain. Try to request a certificate
	//    again, correcting any spelling errors or typos that were in the failed
	//    request, and ensure that all domain names in the request are for valid
	//    top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain
	//    because invalidpublicdomain is not a valid top-level domain.
	//
	//    * OTHER - Typically, this failure occurs when there is a typographical
	//    error in one or more of the domain names in the certificate request. Try
	//    to request a certificate again, correcting any spelling errors or typos
	//    that were in the failed request.
	RequestFailureReason *string `locationName:"requestFailureReason" type:"string"`

	// The reason the certificate was revoked. This value is present only when the
	// certificate status is REVOKED.
	RevocationReason *string `locationName:"revocationReason" type:"string"`

	// The timestamp when the certificate was revoked. This value is present only
	// when the certificate status is REVOKED.
	RevokedAt *time.Time `locationName:"revokedAt" type:"timestamp"`

	// The serial number of the certificate.
	SerialNumber *string `locationName:"serialNumber" type:"string"`

	// The validation status of the certificate.
	Status *string `locationName:"status" type:"string" enum:"CertificateStatus"`

	// An array of strings that specify the alternate domains (e.g., example2.com)
	// and subdomains (e.g., blog.example.com) of the certificate.
	SubjectAlternativeNames []*string `locationName:"subjectAlternativeNames" type:"list"`

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

	// The tag keys and optional values for the resource. For more information about
	// tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

To get a summary of a certificate, use the GetCertificates action and ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

func (Certificate) GoString added in v1.33.11 

func (s Certificate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Certificate) SetArn added in v1.33.11 

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

SetArn sets the Arn field's value.

func (*Certificate) SetCreatedAt added in v1.33.11 

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

SetCreatedAt sets the CreatedAt field's value.

func (*Certificate) SetDomainName added in v1.33.11 

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

SetDomainName sets the DomainName field's value.

func (*Certificate) SetDomainValidationRecords added in v1.33.11 

func (s *Certificate) SetDomainValidationRecords(v []*DomainValidationRecord) *Certificate

SetDomainValidationRecords sets the DomainValidationRecords field's value.

func (*Certificate) SetEligibleToRenew added in v1.33.11 

func (s *Certificate) SetEligibleToRenew(v string) *Certificate

SetEligibleToRenew sets the EligibleToRenew field's value.

func (*Certificate) SetInUseResourceCount added in v1.33.11 

func (s *Certificate) SetInUseResourceCount(v int64) *Certificate

SetInUseResourceCount sets the InUseResourceCount field's value.

func (*Certificate) SetIssuedAt added in v1.33.11 

func (s *Certificate) SetIssuedAt(v time.Time) *Certificate

SetIssuedAt sets the IssuedAt field's value.

func (*Certificate) SetIssuerCA added in v1.33.11 

func (s *Certificate) SetIssuerCA(v string) *Certificate

SetIssuerCA sets the IssuerCA field's value.

func (*Certificate) SetKeyAlgorithm added in v1.33.11 

func (s *Certificate) SetKeyAlgorithm(v string) *Certificate

SetKeyAlgorithm sets the KeyAlgorithm field's value.

func (*Certificate) SetName added in v1.33.11 

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

SetName sets the Name field's value.

func (*Certificate) SetNotAfter added in v1.33.11 

func (s *Certificate) SetNotAfter(v time.Time) *Certificate

SetNotAfter sets the NotAfter field's value.

func (*Certificate) SetNotBefore added in v1.33.11 

func (s *Certificate) SetNotBefore(v time.Time) *Certificate

SetNotBefore sets the NotBefore field's value.

func (*Certificate) SetRenewalSummary added in v1.33.11 

func (s *Certificate) SetRenewalSummary(v *RenewalSummary) *Certificate

SetRenewalSummary sets the RenewalSummary field's value.

func (*Certificate) SetRequestFailureReason added in v1.33.11 

func (s *Certificate) SetRequestFailureReason(v string) *Certificate

SetRequestFailureReason sets the RequestFailureReason field's value.

func (*Certificate) SetRevocationReason added in v1.33.11 

func (s *Certificate) SetRevocationReason(v string) *Certificate

SetRevocationReason sets the RevocationReason field's value.

func (*Certificate) SetRevokedAt added in v1.33.11 

func (s *Certificate) SetRevokedAt(v time.Time) *Certificate

SetRevokedAt sets the RevokedAt field's value.

func (*Certificate) SetSerialNumber added in v1.33.11 

func (s *Certificate) SetSerialNumber(v string) *Certificate

SetSerialNumber sets the SerialNumber field's value.

func (*Certificate) SetStatus added in v1.33.11 

func (s *Certificate) SetStatus(v string) *Certificate

SetStatus sets the Status field's value.

func (*Certificate) SetSubjectAlternativeNames added in v1.33.11 

func (s *Certificate) SetSubjectAlternativeNames(v []*string) *Certificate

SetSubjectAlternativeNames sets the SubjectAlternativeNames field's value.

func (*Certificate) SetSupportCode added in v1.33.11 

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

SetSupportCode sets the SupportCode field's value.

func (*Certificate) SetTags added in v1.33.11 

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

SetTags sets the Tags field's value.

func (Certificate) String added in v1.33.11 

func (s Certificate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CertificateSummary added in v1.33.11 

type CertificateSummary struct {

	// The Amazon Resource Name (ARN) of the certificate.
	CertificateArn *string `locationName:"certificateArn" type:"string"`

	// An object that describes a certificate in detail.
	CertificateDetail *Certificate `locationName:"certificateDetail" type:"structure"`

	// The name of the certificate.
	CertificateName *string `locationName:"certificateName" type:"string"`

	// The domain name of the certificate.
	DomainName *string `locationName:"domainName" type:"string"`

	// The tag keys and optional values for the resource. For more information about
	// tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes an Amazon Lightsail SSL/TLS certificate.

func (CertificateSummary) GoString added in v1.33.11 

func (s CertificateSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateSummary) SetCertificateArn added in v1.33.11 

func (s *CertificateSummary) SetCertificateArn(v string) *CertificateSummary

SetCertificateArn sets the CertificateArn field's value.

func (*CertificateSummary) SetCertificateDetail added in v1.33.11 

func (s *CertificateSummary) SetCertificateDetail(v *Certificate) *CertificateSummary

SetCertificateDetail sets the CertificateDetail field's value.

func (*CertificateSummary) SetCertificateName added in v1.33.11 

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

SetCertificateName sets the CertificateName field's value.

func (*CertificateSummary) SetDomainName added in v1.33.11 

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

SetDomainName sets the DomainName field's value.

func (*CertificateSummary) SetTags added in v1.33.11 

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

SetTags sets the Tags field's value.

func (CertificateSummary) String added in v1.33.11 

func (s CertificateSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloseInstancePublicPortsInput 

type CloseInstancePublicPortsInput struct {

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

	// An object to describe the ports to close for the specified instance.
	//
	// PortInfo is a required field
	PortInfo *PortInfo `locationName:"portInfo" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CloseInstancePublicPortsInput) GoString 

func (s CloseInstancePublicPortsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloseInstancePublicPortsInput) SetInstanceName 

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

SetInstanceName sets the InstanceName field's value.

func (*CloseInstancePublicPortsInput) SetPortInfo 

func (s *CloseInstancePublicPortsInput) SetPortInfo(v *PortInfo) *CloseInstancePublicPortsInput

SetPortInfo sets the PortInfo field's value.

func (CloseInstancePublicPortsInput) String 

func (s CloseInstancePublicPortsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 object that describes the result of the action, such as the status of
	// the request, the timestamp of the request, and the resources affected by
	// the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (CloseInstancePublicPortsOutput) GoString 

func (s CloseInstancePublicPortsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloseInstancePublicPortsOutput) SetOperation 

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

SetOperation sets the Operation field's value.

func (CloseInstancePublicPortsOutput) String 

func (s CloseInstancePublicPortsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudFormationStackRecord added in v1.15.86 

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 Amazon Web Services
	// 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 action.

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

func (s CloudFormationStackRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudFormationStackRecord) SetArn added in v1.15.86 

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

SetArn sets the Arn field's value.

func (*CloudFormationStackRecord) SetCreatedAt added in v1.15.86 

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

SetCreatedAt sets the CreatedAt field's value.

func (*CloudFormationStackRecord) SetDestinationInfo added in v1.15.86 

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

SetDestinationInfo sets the DestinationInfo field's value.

func (*CloudFormationStackRecord) SetLocation added in v1.15.86 

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

SetLocation sets the Location field's value.

func (*CloudFormationStackRecord) SetName added in v1.15.86 

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

SetName sets the Name field's value.

func (*CloudFormationStackRecord) SetResourceType added in v1.15.86 

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

SetResourceType sets the ResourceType field's value.

func (*CloudFormationStackRecord) SetSourceInfo added in v1.15.86 

func (s *CloudFormationStackRecord) SetSourceInfo(v []*CloudFormationStackRecordSourceInfo) *CloudFormationStackRecord

SetSourceInfo sets the SourceInfo field's value.

func (*CloudFormationStackRecord) SetState added in v1.15.86 

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

SetState sets the State field's value.

func (CloudFormationStackRecord) String added in v1.15.86 

func (s CloudFormationStackRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudFormationStackRecordSourceInfo added in v1.15.86 

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

func (s CloudFormationStackRecordSourceInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudFormationStackRecordSourceInfo) SetArn added in v1.15.86 

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

SetArn sets the Arn field's value.

func (*CloudFormationStackRecordSourceInfo) SetName added in v1.15.86 

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

SetName sets the Name field's value.

func (*CloudFormationStackRecordSourceInfo) SetResourceType added in v1.15.86 

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

SetResourceType sets the ResourceType field's value.

func (CloudFormationStackRecordSourceInfo) String added in v1.15.86 

func (s CloudFormationStackRecordSourceInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContactMethod added in v1.29.12 

type ContactMethod struct {

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

	// The destination of the contact method, such as an email address or a mobile
	// phone number.
	ContactEndpoint *string `locationName:"contactEndpoint" type:"string"`

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

	// An object that describes the location of the contact method, such as the
	// Amazon Web Services Region and Availability Zone.
	Location *ResourceLocation `locationName:"location" type:"structure"`

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

	// The protocol of the contact method, such as email or SMS (text messaging).
	Protocol *string `locationName:"protocol" type:"string" enum:"ContactProtocol"`

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

	// The current status of the contact method.
	//
	// A contact method has the following possible status:
	//
	//    * PendingVerification - The contact method has not yet been verified,
	//    and the verification has not yet expired.
	//
	//    * Valid - The contact method has been verified.
	//
	//    * InValid - An attempt was made to verify the contact method, but the
	//    verification has expired.
	Status *string `locationName:"status" type:"string" enum:"ContactMethodStatus"`

	// The support code. Include this code in your email to support when you have
	// questions about your Lightsail contact method. This code enables our support
	// team to look up your Lightsail information more easily.
	SupportCode *string `locationName:"supportCode" type:"string"`
	// contains filtered or unexported fields
}

Describes a contact method.

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).

func (ContactMethod) GoString added in v1.29.12 

func (s ContactMethod) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContactMethod) SetArn added in v1.29.12 

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

SetArn sets the Arn field's value.

func (*ContactMethod) SetContactEndpoint added in v1.29.12 

func (s *ContactMethod) SetContactEndpoint(v string) *ContactMethod

SetContactEndpoint sets the ContactEndpoint field's value.

func (*ContactMethod) SetCreatedAt added in v1.29.12 

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

SetCreatedAt sets the CreatedAt field's value.

func (*ContactMethod) SetLocation added in v1.29.12 

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

SetLocation sets the Location field's value.

func (*ContactMethod) SetName added in v1.29.12 

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

SetName sets the Name field's value.

func (*ContactMethod) SetProtocol added in v1.29.12 

func (s *ContactMethod) SetProtocol(v string) *ContactMethod

SetProtocol sets the Protocol field's value.

func (*ContactMethod) SetResourceType added in v1.29.12 

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

SetResourceType sets the ResourceType field's value.

func (*ContactMethod) SetStatus added in v1.29.12 

func (s *ContactMethod) SetStatus(v string) *ContactMethod

SetStatus sets the Status field's value.

func (*ContactMethod) SetSupportCode added in v1.29.12 

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

SetSupportCode sets the SupportCode field's value.

func (ContactMethod) String added in v1.29.12 

func (s ContactMethod) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Container added in v1.35.27 

type Container struct {

	// The launch command for the container.
	Command []*string `locationName:"command" type:"list"`

	// The environment variables of the container.
	Environment map[string]*string `locationName:"environment" type:"map"`

	// The name of the image used for the container.
	//
	// Container images sourced from your Lightsail container service, that are
	// registered and stored on your service, start with a colon (:). For example,
	// if your container service name is container-service-1, the container image
	// label is mystaticsite, and you want to use the third (3) version of the registered
	// container image, then you should specify :container-service-1.mystaticsite.3.
	// To use the latest version of a container image, specify latest instead of
	// a version number (for example, :container-service-1.mystaticsite.latest).
	// Lightsail will automatically use the highest numbered version of the registered
	// container image.
	//
	// Container images sourced from a public registry like Docker Hub don't start
	// with a colon. For example, nginx:latest or nginx.
	Image *string `locationName:"image" type:"string"`

	// The open firewall ports of the container.
	Ports map[string]*string `locationName:"ports" type:"map"`
	// contains filtered or unexported fields
}

Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

func (Container) GoString added in v1.35.27 

func (s Container) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Container) SetCommand added in v1.35.27 

func (s *Container) SetCommand(v []*string) *Container

SetCommand sets the Command field's value.

func (*Container) SetEnvironment added in v1.35.27 

func (s *Container) SetEnvironment(v map[string]*string) *Container

SetEnvironment sets the Environment field's value.

func (*Container) SetImage added in v1.35.27 

func (s *Container) SetImage(v string) *Container

SetImage sets the Image field's value.

func (*Container) SetPorts added in v1.35.27 

func (s *Container) SetPorts(v map[string]*string) *Container

SetPorts sets the Ports field's value.

func (Container) String added in v1.35.27 

func (s Container) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerImage added in v1.35.27 

type ContainerImage struct {

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

	// The digest of the container image.
	Digest *string `locationName:"digest" type:"string"`

	// The name of the container image.
	Image *string `locationName:"image" type:"string"`
	// contains filtered or unexported fields
}

Describes a container image that is registered to an Amazon Lightsail container service.

func (ContainerImage) GoString added in v1.35.27 

func (s ContainerImage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerImage) SetCreatedAt added in v1.35.27 

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

SetCreatedAt sets the CreatedAt field's value.

func (*ContainerImage) SetDigest added in v1.35.27 

func (s *ContainerImage) SetDigest(v string) *ContainerImage

SetDigest sets the Digest field's value.

func (*ContainerImage) SetImage added in v1.35.27 

func (s *ContainerImage) SetImage(v string) *ContainerImage

SetImage sets the Image field's value.

func (ContainerImage) String added in v1.35.27 

func (s ContainerImage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerService added in v1.35.27 

type ContainerService struct {

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

	// The name of the container service.
	ContainerServiceName *string `locationName:"containerServiceName" min:"1" type:"string"`

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

	// An object that describes the current container deployment of the container
	// service.
	CurrentDeployment *ContainerServiceDeployment `locationName:"currentDeployment" type:"structure"`

	// A Boolean value indicating whether the container service is disabled.
	IsDisabled *bool `locationName:"isDisabled" type:"boolean"`

	// An object that describes the location of the container service, such as the
	// Amazon Web Services Region and Availability Zone.
	Location *ResourceLocation `locationName:"location" type:"structure"`

	// An object that describes the next deployment of the container service.
	//
	// This value is null when there is no deployment in a pending state.
	NextDeployment *ContainerServiceDeployment `locationName:"nextDeployment" type:"structure"`

	// The power specification of the container service.
	//
	// The power specifies the amount of RAM, the number of vCPUs, and the base
	// price of the container service.
	Power *string `locationName:"power" type:"string" enum:"ContainerServicePowerName"`

	// The ID of the power of the container service.
	PowerId *string `locationName:"powerId" type:"string"`

	// The principal ARN of the container service.
	//
	// The principal ARN can be used to create a trust relationship between your
	// standard Amazon Web Services account and your Lightsail container service.
	// This allows you to give your service permission to access resources in your
	// standard Amazon Web Services account.
	PrincipalArn *string `locationName:"principalArn" type:"string"`

	// The private domain name of the container service.
	//
	// The private domain name is accessible only by other resources within the
	// default virtual private cloud (VPC) of your Lightsail account.
	PrivateDomainName *string `locationName:"privateDomainName" type:"string"`

	// An object that describes the configuration for the container service to access
	// private container image repositories, such as Amazon Elastic Container Registry
	// (Amazon ECR) private repositories.
	//
	// For more information, see Configuring access to an Amazon ECR private repository
	// for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access)
	// in the Amazon Lightsail Developer Guide.
	PrivateRegistryAccess *PrivateRegistryAccess `locationName:"privateRegistryAccess" type:"structure"`

	// The public domain name of the container service, such as example.com and
	// www.example.com.
	//
	// You can specify up to four public domain names for a container service. The
	// domain names that you specify are used when you create a deployment with
	// a container configured as the public endpoint of your container service.
	//
	// If you don't specify public domain names, then you can use the default domain
	// of the container service.
	//
	// You must create and validate an SSL/TLS certificate before you can use public
	// domain names with your container service. Use the CreateCertificate action
	// to create a certificate for the public domain names you want to use with
	// your container service.
	//
	// See CreateContainerService or UpdateContainerService for information about
	// how to specify public domain names for your Lightsail container service.
	PublicDomainNames map[string][]*string `locationName:"publicDomainNames" type:"map"`

	// The Lightsail resource type of the container service (i.e., ContainerService).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// The scale specification of the container service.
	//
	// The scale specifies the allocated compute nodes of the container service.
	Scale *int64 `locationName:"scale" min:"1" type:"integer"`

	// The current state of the container service.
	//
	// The following container service states are possible:
	//
	//    * PENDING - The container service is being created.
	//
	//    * READY - The container service is running but it does not have an active
	//    container deployment.
	//
	//    * DEPLOYING - The container service is launching a container deployment.
	//
	//    * RUNNING - The container service is running and it has an active container
	//    deployment.
	//
	//    * UPDATING - The container service capacity or its custom domains are
	//    being updated.
	//
	//    * DELETING - The container service is being deleted.
	//
	//    * DISABLED - The container service is disabled, and its active deployment
	//    and containers, if any, are shut down.
	State *string `locationName:"state" type:"string" enum:"ContainerServiceState"`

	// An object that describes the current state of the container service.
	//
	// The state detail is populated only when a container service is in a PENDING,
	// DEPLOYING, or UPDATING state.
	StateDetail *ContainerServiceStateDetail `locationName:"stateDetail" type:"structure"`

	// The tag keys and optional values for the resource. For more information about
	// tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`

	// The publicly accessible URL of the container service.
	//
	// If no public endpoint is specified in the currentDeployment, this URL returns
	// a 404 response.
	Url *string `locationName:"url" type:"string"`
	// contains filtered or unexported fields
}

Describes an Amazon Lightsail container service.

func (ContainerService) GoString added in v1.35.27 

func (s ContainerService) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerService) SetArn added in v1.35.27 

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

SetArn sets the Arn field's value.

func (*ContainerService) SetContainerServiceName added in v1.35.27 

func (s *ContainerService) SetContainerServiceName(v string) *ContainerService

SetContainerServiceName sets the ContainerServiceName field's value.

func (*ContainerService) SetCreatedAt added in v1.35.27 

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

SetCreatedAt sets the CreatedAt field's value.

func (*ContainerService) SetCurrentDeployment added in v1.35.27 

func (s *ContainerService) SetCurrentDeployment(v *ContainerServiceDeployment) *ContainerService

SetCurrentDeployment sets the CurrentDeployment field's value.

func (*ContainerService) SetIsDisabled added in v1.35.27 

func (s *ContainerService) SetIsDisabled(v bool) *ContainerService

SetIsDisabled sets the IsDisabled field's value.

func (*ContainerService) SetLocation added in v1.35.27 

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

SetLocation sets the Location field's value.

func (*ContainerService) SetNextDeployment added in v1.35.27 

func (s *ContainerService) SetNextDeployment(v *ContainerServiceDeployment) *ContainerService

SetNextDeployment sets the NextDeployment field's value.

func (*ContainerService) SetPower added in v1.35.27 

func (s *ContainerService) SetPower(v string) *ContainerService

SetPower sets the Power field's value.

func (*ContainerService) SetPowerId added in v1.35.27 

func (s *ContainerService) SetPowerId(v string) *ContainerService

SetPowerId sets the PowerId field's value.

func (*ContainerService) SetPrincipalArn added in v1.35.27 

func (s *ContainerService) SetPrincipalArn(v string) *ContainerService

SetPrincipalArn sets the PrincipalArn field's value.

func (*ContainerService) SetPrivateDomainName added in v1.35.27 

func (s *ContainerService) SetPrivateDomainName(v string) *ContainerService

SetPrivateDomainName sets the PrivateDomainName field's value.

func (*ContainerService) SetPrivateRegistryAccess added in v1.44.23 

func (s *ContainerService) SetPrivateRegistryAccess(v *PrivateRegistryAccess) *ContainerService

SetPrivateRegistryAccess sets the PrivateRegistryAccess field's value.

func (*ContainerService) SetPublicDomainNames added in v1.35.27 

func (s *ContainerService) SetPublicDomainNames(v map[string][]*string) *ContainerService

SetPublicDomainNames sets the PublicDomainNames field's value.

func (*ContainerService) SetResourceType added in v1.35.27 

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

SetResourceType sets the ResourceType field's value.

func (*ContainerService) SetScale added in v1.35.27 

func (s *ContainerService) SetScale(v int64) *ContainerService

SetScale sets the Scale field's value.

func (*ContainerService) SetState added in v1.35.27 

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

SetState sets the State field's value.

func (*ContainerService) SetStateDetail added in v1.38.11 

func (s *ContainerService) SetStateDetail(v *ContainerServiceStateDetail) *ContainerService

SetStateDetail sets the StateDetail field's value.

func (*ContainerService) SetTags added in v1.35.27 

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

SetTags sets the Tags field's value.

func (*ContainerService) SetUrl added in v1.35.27 

func (s *ContainerService) SetUrl(v string) *ContainerService

SetUrl sets the Url field's value.

func (ContainerService) String added in v1.35.27 

func (s ContainerService) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServiceDeployment added in v1.35.27 

type ContainerServiceDeployment struct {

	// An object that describes the configuration for the containers of the deployment.
	Containers map[string]*Container `locationName:"containers" type:"map"`

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

	// An object that describes the endpoint of the deployment.
	PublicEndpoint *ContainerServiceEndpoint `locationName:"publicEndpoint" type:"structure"`

	// The state of the deployment.
	//
	// A deployment can be in one of the following states:
	//
	//    * Activating - The deployment is being created.
	//
	//    * Active - The deployment was successfully created, and it's currently
	//    running on the container service. The container service can have only
	//    one deployment in an active state at a time.
	//
	//    * Inactive - The deployment was previously successfully created, but it
	//    is not currently running on the container service.
	//
	//    * Failed - The deployment failed. Use the GetContainerLog action to view
	//    the log events for the containers in the deployment to try to determine
	//    the reason for the failure.
	State *string `locationName:"state" type:"string" enum:"ContainerServiceDeploymentState"`

	// The version number of the deployment.
	Version *int64 `locationName:"version" type:"integer"`
	// contains filtered or unexported fields
}

Describes a container deployment configuration of an Amazon Lightsail container service.

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

func (ContainerServiceDeployment) GoString added in v1.35.27 

func (s ContainerServiceDeployment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceDeployment) SetContainers added in v1.35.27 

func (s *ContainerServiceDeployment) SetContainers(v map[string]*Container) *ContainerServiceDeployment

SetContainers sets the Containers field's value.

func (*ContainerServiceDeployment) SetCreatedAt added in v1.35.27 

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

SetCreatedAt sets the CreatedAt field's value.

func (*ContainerServiceDeployment) SetPublicEndpoint added in v1.35.27 

func (s *ContainerServiceDeployment) SetPublicEndpoint(v *ContainerServiceEndpoint) *ContainerServiceDeployment

SetPublicEndpoint sets the PublicEndpoint field's value.

func (*ContainerServiceDeployment) SetState added in v1.35.27 

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

SetState sets the State field's value.

func (*ContainerServiceDeployment) SetVersion added in v1.35.27 

func (s *ContainerServiceDeployment) SetVersion(v int64) *ContainerServiceDeployment

SetVersion sets the Version field's value.

func (ContainerServiceDeployment) String added in v1.35.27 

func (s ContainerServiceDeployment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServiceDeploymentRequest added in v1.35.27 

type ContainerServiceDeploymentRequest struct {

	// An object that describes the configuration for the containers of the deployment.
	Containers map[string]*Container `locationName:"containers" type:"map"`

	// An object that describes the endpoint of the deployment.
	PublicEndpoint *EndpointRequest `locationName:"publicEndpoint" type:"structure"`
	// contains filtered or unexported fields
}

Describes a container deployment configuration of an Amazon Lightsail container service.

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

func (ContainerServiceDeploymentRequest) GoString added in v1.35.27 

func (s ContainerServiceDeploymentRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceDeploymentRequest) SetContainers added in v1.35.27 

func (s *ContainerServiceDeploymentRequest) SetContainers(v map[string]*Container) *ContainerServiceDeploymentRequest

SetContainers sets the Containers field's value.

func (*ContainerServiceDeploymentRequest) SetPublicEndpoint added in v1.35.27 

func (s *ContainerServiceDeploymentRequest) SetPublicEndpoint(v *EndpointRequest) *ContainerServiceDeploymentRequest

SetPublicEndpoint sets the PublicEndpoint field's value.

func (ContainerServiceDeploymentRequest) String added in v1.35.27 

func (s ContainerServiceDeploymentRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceDeploymentRequest) Validate added in v1.35.27 

func (s *ContainerServiceDeploymentRequest) Validate() error

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

type ContainerServiceECRImagePullerRole added in v1.44.23 

type ContainerServiceECRImagePullerRole struct {

	// A Boolean value that indicates whether the role is activated.
	IsActive *bool `locationName:"isActive" type:"boolean"`

	// The Amazon Resource Name (ARN) of the role, if it is activated.
	PrincipalArn *string `locationName:"principalArn" type:"string"`
	// contains filtered or unexported fields
}

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) in the Amazon Lightsail Developer Guide.

func (ContainerServiceECRImagePullerRole) GoString added in v1.44.23 

func (s ContainerServiceECRImagePullerRole) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceECRImagePullerRole) SetIsActive added in v1.44.23 

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

SetIsActive sets the IsActive field's value.

func (*ContainerServiceECRImagePullerRole) SetPrincipalArn added in v1.44.23 

func (s *ContainerServiceECRImagePullerRole) SetPrincipalArn(v string) *ContainerServiceECRImagePullerRole

SetPrincipalArn sets the PrincipalArn field's value.

func (ContainerServiceECRImagePullerRole) String added in v1.44.23 

func (s ContainerServiceECRImagePullerRole) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServiceECRImagePullerRoleRequest added in v1.44.23 

type ContainerServiceECRImagePullerRoleRequest struct {

	// A Boolean value that indicates whether to activate the role.
	IsActive *bool `locationName:"isActive" type:"boolean"`
	// contains filtered or unexported fields
}

Describes a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) in the Amazon Lightsail Developer Guide.

func (ContainerServiceECRImagePullerRoleRequest) GoString added in v1.44.23 

func (s ContainerServiceECRImagePullerRoleRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceECRImagePullerRoleRequest) SetIsActive added in v1.44.23 

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

SetIsActive sets the IsActive field's value.

func (ContainerServiceECRImagePullerRoleRequest) String added in v1.44.23 

func (s ContainerServiceECRImagePullerRoleRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServiceEndpoint added in v1.35.27 

type ContainerServiceEndpoint struct {

	// The name of the container entry of the deployment that the endpoint configuration
	// applies to.
	ContainerName *string `locationName:"containerName" type:"string"`

	// The port of the specified container to which traffic is forwarded to.
	ContainerPort *int64 `locationName:"containerPort" type:"integer"`

	// An object that describes the health check configuration of the container.
	HealthCheck *ContainerServiceHealthCheckConfig `locationName:"healthCheck" type:"structure"`
	// contains filtered or unexported fields
}

Describes the public endpoint configuration of a deployment of an Amazon Lightsail container service.

func (ContainerServiceEndpoint) GoString added in v1.35.27 

func (s ContainerServiceEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceEndpoint) SetContainerName added in v1.35.27 

func (s *ContainerServiceEndpoint) SetContainerName(v string) *ContainerServiceEndpoint

SetContainerName sets the ContainerName field's value.

func (*ContainerServiceEndpoint) SetContainerPort added in v1.35.27 

func (s *ContainerServiceEndpoint) SetContainerPort(v int64) *ContainerServiceEndpoint

SetContainerPort sets the ContainerPort field's value.

func (*ContainerServiceEndpoint) SetHealthCheck added in v1.35.27 

func (s *ContainerServiceEndpoint) SetHealthCheck(v *ContainerServiceHealthCheckConfig) *ContainerServiceEndpoint

SetHealthCheck sets the HealthCheck field's value.

func (ContainerServiceEndpoint) String added in v1.35.27 

func (s ContainerServiceEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServiceHealthCheckConfig added in v1.35.27 

type ContainerServiceHealthCheckConfig struct {

	// The number of consecutive health checks successes required before moving
	// the container to the Healthy state. The default value is 2.
	HealthyThreshold *int64 `locationName:"healthyThreshold" type:"integer"`

	// The approximate interval, in seconds, between health checks of an individual
	// container. You can specify between 5 and 300 seconds. The default value is
	// 5.
	IntervalSeconds *int64 `locationName:"intervalSeconds" type:"integer"`

	// The path on the container on which to perform the health check. The default
	// value is /.
	Path *string `locationName:"path" type:"string"`

	// The HTTP codes to use when checking for a successful response from a container.
	// You can specify values between 200 and 499. You can specify multiple values
	// (for example, 200,202) or a range of values (for example, 200-299).
	SuccessCodes *string `locationName:"successCodes" type:"string"`

	// The amount of time, in seconds, during which no response means a failed health
	// check. You can specify between 2 and 60 seconds. The default value is 2.
	TimeoutSeconds *int64 `locationName:"timeoutSeconds" type:"integer"`

	// The number of consecutive health check failures required before moving the
	// container to the Unhealthy state. The default value is 2.
	UnhealthyThreshold *int64 `locationName:"unhealthyThreshold" type:"integer"`
	// contains filtered or unexported fields
}

Describes the health check configuration of an Amazon Lightsail container service.

func (ContainerServiceHealthCheckConfig) GoString added in v1.35.27 

func (s ContainerServiceHealthCheckConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceHealthCheckConfig) SetHealthyThreshold added in v1.35.27 

func (s *ContainerServiceHealthCheckConfig) SetHealthyThreshold(v int64) *ContainerServiceHealthCheckConfig

SetHealthyThreshold sets the HealthyThreshold field's value.

func (*ContainerServiceHealthCheckConfig) SetIntervalSeconds added in v1.35.27 

func (s *ContainerServiceHealthCheckConfig) SetIntervalSeconds(v int64) *ContainerServiceHealthCheckConfig

SetIntervalSeconds sets the IntervalSeconds field's value.

func (*ContainerServiceHealthCheckConfig) SetPath added in v1.35.27 

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

SetPath sets the Path field's value.

func (*ContainerServiceHealthCheckConfig) SetSuccessCodes added in v1.35.27 

func (s *ContainerServiceHealthCheckConfig) SetSuccessCodes(v string) *ContainerServiceHealthCheckConfig

SetSuccessCodes sets the SuccessCodes field's value.

func (*ContainerServiceHealthCheckConfig) SetTimeoutSeconds added in v1.35.27 

func (s *ContainerServiceHealthCheckConfig) SetTimeoutSeconds(v int64) *ContainerServiceHealthCheckConfig

SetTimeoutSeconds sets the TimeoutSeconds field's value.

func (*ContainerServiceHealthCheckConfig) SetUnhealthyThreshold added in v1.35.27 

func (s *ContainerServiceHealthCheckConfig) SetUnhealthyThreshold(v int64) *ContainerServiceHealthCheckConfig

SetUnhealthyThreshold sets the UnhealthyThreshold field's value.

func (ContainerServiceHealthCheckConfig) String added in v1.35.27 

func (s ContainerServiceHealthCheckConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServiceLogEvent added in v1.35.27 

type ContainerServiceLogEvent struct {

	// The timestamp when the container service log event was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The message of the container service log event.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Describes the log events of a container of an Amazon Lightsail container service.

func (ContainerServiceLogEvent) GoString added in v1.35.27 

func (s ContainerServiceLogEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceLogEvent) SetCreatedAt added in v1.35.27 

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

SetCreatedAt sets the CreatedAt field's value.

func (*ContainerServiceLogEvent) SetMessage added in v1.35.27 

func (s *ContainerServiceLogEvent) SetMessage(v string) *ContainerServiceLogEvent

SetMessage sets the Message field's value.

func (ContainerServiceLogEvent) String added in v1.35.27 

func (s ContainerServiceLogEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServicePower added in v1.35.27 

type ContainerServicePower struct {

	// The number of vCPUs included in the power.
	CpuCount *float64 `locationName:"cpuCount" type:"float"`

	// A Boolean value indicating whether the power is active and can be specified
	// for container services.
	IsActive *bool `locationName:"isActive" type:"boolean"`

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

	// The ID of the power (e.g., nano-1).
	PowerId *string `locationName:"powerId" type:"string"`

	// The monthly price of the power in USD.
	Price *float64 `locationName:"price" type:"float"`

	// The amount of RAM (in GB) of the power.
	RamSizeInGb *float64 `locationName:"ramSizeInGb" type:"float"`
	// contains filtered or unexported fields
}

Describes the powers that can be specified for an Amazon Lightsail container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

func (ContainerServicePower) GoString added in v1.35.27 

func (s ContainerServicePower) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServicePower) SetCpuCount added in v1.35.27 

func (s *ContainerServicePower) SetCpuCount(v float64) *ContainerServicePower

SetCpuCount sets the CpuCount field's value.

func (*ContainerServicePower) SetIsActive added in v1.35.27 

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

SetIsActive sets the IsActive field's value.

func (*ContainerServicePower) SetName added in v1.35.27 

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

SetName sets the Name field's value.

func (*ContainerServicePower) SetPowerId added in v1.35.27 

func (s *ContainerServicePower) SetPowerId(v string) *ContainerServicePower

SetPowerId sets the PowerId field's value.

func (*ContainerServicePower) SetPrice added in v1.35.27 

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

SetPrice sets the Price field's value.

func (*ContainerServicePower) SetRamSizeInGb added in v1.35.27 

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

SetRamSizeInGb sets the RamSizeInGb field's value.

func (ContainerServicePower) String added in v1.35.27 

func (s ContainerServicePower) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServiceRegistryLogin added in v1.35.27 

type ContainerServiceRegistryLogin struct {

	// The timestamp of when the container image registry username and password
	// expire.
	//
	// The log in credentials expire 12 hours after they are created, at which point
	// you will need to create a new set of log in credentials using the CreateContainerServiceRegistryLogin
	// action.
	ExpiresAt *time.Time `locationName:"expiresAt" type:"timestamp"`

	// The container service registry password to use to push container images to
	// the container image registry of a Lightsail account
	Password *string `locationName:"password" type:"string"`

	// The address to use to push container images to the container image registry
	// of a Lightsail account.
	Registry *string `locationName:"registry" type:"string"`

	// The container service registry username to use to push container images to
	// the container image registry of a Lightsail account.
	Username *string `locationName:"username" type:"string"`
	// contains filtered or unexported fields
}

Describes the login information for the container image registry of an Amazon Lightsail account.

func (ContainerServiceRegistryLogin) GoString added in v1.35.27 

func (s ContainerServiceRegistryLogin) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceRegistryLogin) SetExpiresAt added in v1.35.27 

func (s *ContainerServiceRegistryLogin) SetExpiresAt(v time.Time) *ContainerServiceRegistryLogin

SetExpiresAt sets the ExpiresAt field's value.

func (*ContainerServiceRegistryLogin) SetPassword added in v1.35.27 

func (s *ContainerServiceRegistryLogin) SetPassword(v string) *ContainerServiceRegistryLogin

SetPassword sets the Password field's value.

func (*ContainerServiceRegistryLogin) SetRegistry added in v1.35.27 

func (s *ContainerServiceRegistryLogin) SetRegistry(v string) *ContainerServiceRegistryLogin

SetRegistry sets the Registry field's value.

func (*ContainerServiceRegistryLogin) SetUsername added in v1.35.27 

func (s *ContainerServiceRegistryLogin) SetUsername(v string) *ContainerServiceRegistryLogin

SetUsername sets the Username field's value.

func (ContainerServiceRegistryLogin) String added in v1.35.27 

func (s ContainerServiceRegistryLogin) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainerServiceStateDetail added in v1.38.11 

type ContainerServiceStateDetail struct {

	// The state code of the container service.
	//
	// The following state codes are possible:
	//
	//    * The following state codes are possible if your container service is
	//    in a DEPLOYING or UPDATING state: CREATING_SYSTEM_RESOURCES - The system
	//    resources for your container service are being created. CREATING_NETWORK_INFRASTRUCTURE
	//    - The network infrastructure for your container service are being created.
	//    PROVISIONING_CERTIFICATE - The SSL/TLS certificate for your container
	//    service is being created. PROVISIONING_SERVICE - Your container service
	//    is being provisioned. CREATING_DEPLOYMENT - Your deployment is being created
	//    on your container service. EVALUATING_HEALTH_CHECK - The health of your
	//    deployment is being evaluated. ACTIVATING_DEPLOYMENT - Your deployment
	//    is being activated.
	//
	//    * The following state codes are possible if your container service is
	//    in a PENDING state: CERTIFICATE_LIMIT_EXCEEDED - The SSL/TLS certificate
	//    required for your container service exceeds the maximum number of certificates
	//    allowed for your account. UNKNOWN_ERROR - An error was experienced when
	//    your container service was being created.
	Code *string `locationName:"code" type:"string" enum:"ContainerServiceStateDetailCode"`

	// A message that provides more information for the state code.
	//
	// The state detail is populated only when a container service is in a PENDING,
	// DEPLOYING, or UPDATING state.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Describes the current state of a container service.

func (ContainerServiceStateDetail) GoString added in v1.38.11 

func (s ContainerServiceStateDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerServiceStateDetail) SetCode added in v1.38.11 

func (s *ContainerServiceStateDetail) SetCode(v string) *ContainerServiceStateDetail

SetCode sets the Code field's value.

func (*ContainerServiceStateDetail) SetMessage added in v1.38.11 

func (s *ContainerServiceStateDetail) SetMessage(v string) *ContainerServiceStateDetail

SetMessage sets the Message field's value.

func (ContainerServiceStateDetail) String added in v1.38.11 

func (s ContainerServiceStateDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CookieObject added in v1.33.11 

type CookieObject struct {

	// The specific cookies to forward to your distribution's origin.
	CookiesAllowList []*string `locationName:"cookiesAllowList" type:"list"`

	// Specifies which cookies to forward to the distribution's origin for a cache
	// behavior: all, none, or allow-list to forward only the cookies specified
	// in the cookiesAllowList parameter.
	Option *string `locationName:"option" type:"string" enum:"ForwardValues"`
	// contains filtered or unexported fields
}

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.

func (CookieObject) GoString added in v1.33.11 

func (s CookieObject) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CookieObject) SetCookiesAllowList added in v1.33.11 

func (s *CookieObject) SetCookiesAllowList(v []*string) *CookieObject

SetCookiesAllowList sets the CookiesAllowList field's value.

func (*CookieObject) SetOption added in v1.33.11 

func (s *CookieObject) SetOption(v string) *CookieObject

SetOption sets the Option field's value.

func (CookieObject) String added in v1.33.11 

func (s CookieObject) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopySnapshotInput added in v1.15.86 

type CopySnapshotInput struct {

	// The date of the source automatic snapshot to copy. Use the get auto snapshots
	// operation to identify the dates of the available automatic snapshots.
	//
	// Constraints:
	//
	//    * Must be specified in YYYY-MM-DD format.
	//
	//    * This parameter cannot be defined together with the use latest restorable
	//    auto snapshot parameter. The restore date and use latest restorable auto
	//    snapshot parameters are mutually exclusive.
	//
	//    * Define this parameter only when copying an automatic snapshot as a manual
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots).
	RestoreDate *string `locationName:"restoreDate" type:"string"`

	// The Amazon Web Services Region where the source manual or automatic 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 from which the source automatic snapshot
	// was created.
	//
	// Constraint:
	//
	//    * Define this parameter only when copying an automatic snapshot as a manual
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots).
	SourceResourceName *string `locationName:"sourceResourceName" type:"string"`

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

	// The name of the new manual snapshot to be created as a copy.
	//
	// TargetSnapshotName is a required field
	TargetSnapshotName *string `locationName:"targetSnapshotName" type:"string" required:"true"`

	// A Boolean value to indicate whether to use the latest available automatic
	// snapshot of the specified source instance or disk.
	//
	// Constraints:
	//
	//    * This parameter cannot be defined together with the restore date parameter.
	//    The use latest restorable auto snapshot and restore date parameters are
	//    mutually exclusive.
	//
	//    * Define this parameter only when copying an automatic snapshot as a manual
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots).
	UseLatestRestorableAutoSnapshot *bool `locationName:"useLatestRestorableAutoSnapshot" type:"boolean"`
	// contains filtered or unexported fields
}

func (CopySnapshotInput) GoString added in v1.15.86 

func (s CopySnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopySnapshotInput) SetRestoreDate added in v1.25.4 

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

SetRestoreDate sets the RestoreDate field's value.

func (*CopySnapshotInput) SetSourceRegion added in v1.15.86 

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

SetSourceRegion sets the SourceRegion field's value.

func (*CopySnapshotInput) SetSourceResourceName added in v1.25.4 

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

SetSourceResourceName sets the SourceResourceName field's value.

func (*CopySnapshotInput) SetSourceSnapshotName added in v1.15.86 

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

SetSourceSnapshotName sets the SourceSnapshotName field's value.

func (*CopySnapshotInput) SetTargetSnapshotName added in v1.15.86 

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

SetTargetSnapshotName sets the TargetSnapshotName field's value.

func (*CopySnapshotInput) SetUseLatestRestorableAutoSnapshot added in v1.25.4 

func (s *CopySnapshotInput) SetUseLatestRestorableAutoSnapshot(v bool) *CopySnapshotInput

SetUseLatestRestorableAutoSnapshot sets the UseLatestRestorableAutoSnapshot field's value.

func (CopySnapshotInput) String added in v1.15.86 

func (s CopySnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopySnapshotInput) Validate added in v1.15.86 

func (s *CopySnapshotInput) Validate() error

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

type CopySnapshotOutput added in v1.15.86 

type CopySnapshotOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CopySnapshotOutput) GoString added in v1.15.86 

func (s CopySnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopySnapshotOutput) SetOperations added in v1.15.86 

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

SetOperations sets the Operations field's value.

func (CopySnapshotOutput) String added in v1.15.86 

func (s CopySnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBucketAccessKeyInput added in v1.40.0 

type CreateBucketAccessKeyInput struct {

	// The name of the bucket that the new access key will belong to, and grant
	// access to.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateBucketAccessKeyInput) GoString added in v1.40.0 

func (s CreateBucketAccessKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBucketAccessKeyInput) SetBucketName added in v1.40.0 

func (s *CreateBucketAccessKeyInput) SetBucketName(v string) *CreateBucketAccessKeyInput

SetBucketName sets the BucketName field's value.

func (CreateBucketAccessKeyInput) String added in v1.40.0 

func (s CreateBucketAccessKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBucketAccessKeyInput) Validate added in v1.40.0 

func (s *CreateBucketAccessKeyInput) Validate() error

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

type CreateBucketAccessKeyOutput added in v1.40.0 

type CreateBucketAccessKeyOutput struct {

	// An object that describes the access key that is created.
	AccessKey *AccessKey `locationName:"accessKey" type:"structure"`

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateBucketAccessKeyOutput) GoString added in v1.40.0 

func (s CreateBucketAccessKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBucketAccessKeyOutput) SetAccessKey added in v1.40.0 

func (s *CreateBucketAccessKeyOutput) SetAccessKey(v *AccessKey) *CreateBucketAccessKeyOutput

SetAccessKey sets the AccessKey field's value.

func (*CreateBucketAccessKeyOutput) SetOperations added in v1.40.0 

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

SetOperations sets the Operations field's value.

func (CreateBucketAccessKeyOutput) String added in v1.40.0 

func (s CreateBucketAccessKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBucketInput added in v1.40.0 

type CreateBucketInput struct {

	// The name for the bucket.
	//
	// For more information about bucket names, see Bucket naming rules in Amazon
	// Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/bucket-naming-rules-in-amazon-lightsail)
	// in the Amazon Lightsail Developer Guide.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`

	// The ID of the bundle to use for the bucket.
	//
	// A bucket bundle specifies the monthly cost, storage space, and data transfer
	// quota for a bucket.
	//
	// Use the GetBucketBundles (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html)
	// action to get a list of bundle IDs that you can specify.
	//
	// Use the UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html)
	// action to change the bundle after the bucket is created.
	//
	// BundleId is a required field
	BundleId *string `locationName:"bundleId" type:"string" required:"true"`

	// A Boolean value that indicates whether to enable versioning of objects in
	// the bucket.
	//
	// For more information about versioning, see Enabling and suspending object
	// versioning in a bucket in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning)
	// in the Amazon Lightsail Developer Guide.
	EnableObjectVersioning *bool `locationName:"enableObjectVersioning" type:"boolean"`

	// The tag keys and optional values to add to the bucket during creation.
	//
	// Use the TagResource (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_TagResource.html)
	// action to tag the bucket after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateBucketInput) GoString added in v1.40.0 

func (s CreateBucketInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBucketInput) SetBucketName added in v1.40.0 

func (s *CreateBucketInput) SetBucketName(v string) *CreateBucketInput

SetBucketName sets the BucketName field's value.

func (*CreateBucketInput) SetBundleId added in v1.40.0 

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

SetBundleId sets the BundleId field's value.

func (*CreateBucketInput) SetEnableObjectVersioning added in v1.40.0 

func (s *CreateBucketInput) SetEnableObjectVersioning(v bool) *CreateBucketInput

SetEnableObjectVersioning sets the EnableObjectVersioning field's value.

func (*CreateBucketInput) SetTags added in v1.40.0 

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

SetTags sets the Tags field's value.

func (CreateBucketInput) String added in v1.40.0 

func (s CreateBucketInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBucketInput) Validate added in v1.40.0 

func (s *CreateBucketInput) Validate() error

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

type CreateBucketOutput added in v1.40.0 

type CreateBucketOutput struct {

	// An object that describes the bucket that is created.
	Bucket *Bucket `locationName:"bucket" type:"structure"`

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateBucketOutput) GoString added in v1.40.0 

func (s CreateBucketOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBucketOutput) SetBucket added in v1.40.0 

func (s *CreateBucketOutput) SetBucket(v *Bucket) *CreateBucketOutput

SetBucket sets the Bucket field's value.

func (*CreateBucketOutput) SetOperations added in v1.40.0 

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

SetOperations sets the Operations field's value.

func (CreateBucketOutput) String added in v1.40.0 

func (s CreateBucketOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCertificateInput added in v1.33.11 

type CreateCertificateInput struct {

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

	// The domain name (e.g., example.com) for the certificate.
	//
	// DomainName is a required field
	DomainName *string `locationName:"domainName" type:"string" required:"true"`

	// An array of strings that specify the alternate domains (e.g., example2.com)
	// and subdomains (e.g., blog.example.com) for the certificate.
	//
	// You can specify a maximum of nine alternate domains (in addition to the primary
	// domain name).
	//
	// Wildcard domain entries (e.g., *.example.com) are not supported.
	SubjectAlternativeNames []*string `locationName:"subjectAlternativeNames" type:"list"`

	// The tag keys and optional values to add to the certificate during create.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateCertificateInput) GoString added in v1.33.11 

func (s CreateCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCertificateInput) SetCertificateName added in v1.33.11 

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

SetCertificateName sets the CertificateName field's value.

func (*CreateCertificateInput) SetDomainName added in v1.33.11 

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

SetDomainName sets the DomainName field's value.

func (*CreateCertificateInput) SetSubjectAlternativeNames added in v1.33.11 

func (s *CreateCertificateInput) SetSubjectAlternativeNames(v []*string) *CreateCertificateInput

SetSubjectAlternativeNames sets the SubjectAlternativeNames field's value.

func (*CreateCertificateInput) SetTags added in v1.33.11 

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

SetTags sets the Tags field's value.

func (CreateCertificateInput) String added in v1.33.11 

func (s CreateCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCertificateInput) Validate added in v1.33.11 

func (s *CreateCertificateInput) Validate() error

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

type CreateCertificateOutput added in v1.33.11 

type CreateCertificateOutput struct {

	// An object that describes the certificate created.
	Certificate *CertificateSummary `locationName:"certificate" type:"structure"`

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateCertificateOutput) GoString added in v1.33.11 

func (s CreateCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCertificateOutput) SetCertificate added in v1.33.11 

func (s *CreateCertificateOutput) SetCertificate(v *CertificateSummary) *CreateCertificateOutput

SetCertificate sets the Certificate field's value.

func (*CreateCertificateOutput) SetOperations added in v1.33.11 

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

SetOperations sets the Operations field's value.

func (CreateCertificateOutput) String added in v1.33.11 

func (s CreateCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateCloudFormationStackInput added in v1.15.86 

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

func (s CreateCloudFormationStackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCloudFormationStackInput) SetInstances added in v1.15.86 

func (s *CreateCloudFormationStackInput) SetInstances(v []*InstanceEntry) *CreateCloudFormationStackInput

SetInstances sets the Instances field's value.

func (CreateCloudFormationStackInput) String added in v1.15.86 

func (s CreateCloudFormationStackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCloudFormationStackInput) Validate added in v1.15.86 

func (s *CreateCloudFormationStackInput) Validate() error

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

type CreateCloudFormationStackOutput added in v1.15.86 

type CreateCloudFormationStackOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateCloudFormationStackOutput) GoString added in v1.15.86 

func (s CreateCloudFormationStackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateCloudFormationStackOutput) SetOperations added in v1.15.86 

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

SetOperations sets the Operations field's value.

func (CreateCloudFormationStackOutput) String added in v1.15.86 

func (s CreateCloudFormationStackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateContactMethodInput added in v1.29.12 

type CreateContactMethodInput struct {

	// The destination of the contact method, such as an email address or a mobile
	// phone number.
	//
	// Use the E.164 format when specifying a mobile phone number. E.164 is a standard
	// for the phone number structure used for international telecommunication.
	// Phone numbers that follow this format can have a maximum of 15 digits, and
	// they are prefixed with the plus character (+) and the country code. For example,
	// a U.S. phone number in E.164 format would be specified as +1XXX5550100. For
	// more information, see E.164 (https://en.wikipedia.org/wiki/E.164) on Wikipedia.
	//
	// ContactEndpoint is a required field
	ContactEndpoint *string `locationName:"contactEndpoint" min:"1" type:"string" required:"true"`

	// The protocol of the contact method, such as Email or SMS (text messaging).
	//
	// The SMS protocol is supported only in the following Amazon Web Services Regions.
	//
	//    * US East (N. Virginia) (us-east-1)
	//
	//    * US West (Oregon) (us-west-2)
	//
	//    * Europe (Ireland) (eu-west-1)
	//
	//    * Asia Pacific (Tokyo) (ap-northeast-1)
	//
	//    * Asia Pacific (Singapore) (ap-southeast-1)
	//
	//    * Asia Pacific (Sydney) (ap-southeast-2)
	//
	// For a list of countries/regions where SMS text messages can be sent, and
	// the latest Amazon Web Services Regions where SMS text messaging is supported,
	// see Supported Regions and Countries (https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html)
	// in the Amazon SNS Developer Guide.
	//
	// For more information about notifications in Amazon Lightsail, see Notifications
	// in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"ContactProtocol"`
	// contains filtered or unexported fields
}

func (CreateContactMethodInput) GoString added in v1.29.12 

func (s CreateContactMethodInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactMethodInput) SetContactEndpoint added in v1.29.12 

func (s *CreateContactMethodInput) SetContactEndpoint(v string) *CreateContactMethodInput

SetContactEndpoint sets the ContactEndpoint field's value.

func (*CreateContactMethodInput) SetProtocol added in v1.29.12 

func (s *CreateContactMethodInput) SetProtocol(v string) *CreateContactMethodInput

SetProtocol sets the Protocol field's value.

func (CreateContactMethodInput) String added in v1.29.12 

func (s CreateContactMethodInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactMethodInput) Validate added in v1.29.12 

func (s *CreateContactMethodInput) Validate() error

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

type CreateContactMethodOutput added in v1.29.12 

type CreateContactMethodOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateContactMethodOutput) GoString added in v1.29.12 

func (s CreateContactMethodOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContactMethodOutput) SetOperations added in v1.29.12 

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

SetOperations sets the Operations field's value.

func (CreateContactMethodOutput) String added in v1.29.12 

func (s CreateContactMethodOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateContainerServiceDeploymentInput added in v1.35.27 

type CreateContainerServiceDeploymentInput struct {

	// An object that describes the settings of the containers that will be launched
	// on the container service.
	Containers map[string]*Container `locationName:"containers" type:"map"`

	// An object that describes the settings of the public endpoint for the container
	// service.
	PublicEndpoint *EndpointRequest `locationName:"publicEndpoint" type:"structure"`

	// The name of the container service for which to create the deployment.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateContainerServiceDeploymentInput) GoString added in v1.35.27 

func (s CreateContainerServiceDeploymentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerServiceDeploymentInput) SetContainers added in v1.35.27 

func (s *CreateContainerServiceDeploymentInput) SetContainers(v map[string]*Container) *CreateContainerServiceDeploymentInput

SetContainers sets the Containers field's value.

func (*CreateContainerServiceDeploymentInput) SetPublicEndpoint added in v1.35.27 

func (s *CreateContainerServiceDeploymentInput) SetPublicEndpoint(v *EndpointRequest) *CreateContainerServiceDeploymentInput

SetPublicEndpoint sets the PublicEndpoint field's value.

func (*CreateContainerServiceDeploymentInput) SetServiceName added in v1.35.27 

func (s *CreateContainerServiceDeploymentInput) SetServiceName(v string) *CreateContainerServiceDeploymentInput

SetServiceName sets the ServiceName field's value.

func (CreateContainerServiceDeploymentInput) String added in v1.35.27 

func (s CreateContainerServiceDeploymentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerServiceDeploymentInput) Validate added in v1.35.27 

func (s *CreateContainerServiceDeploymentInput) Validate() error

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

type CreateContainerServiceDeploymentOutput added in v1.35.27 

type CreateContainerServiceDeploymentOutput struct {

	// An object that describes a container service.
	ContainerService *ContainerService `locationName:"containerService" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateContainerServiceDeploymentOutput) GoString added in v1.35.27 

func (s CreateContainerServiceDeploymentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerServiceDeploymentOutput) SetContainerService added in v1.35.27 

func (s *CreateContainerServiceDeploymentOutput) SetContainerService(v *ContainerService) *CreateContainerServiceDeploymentOutput

SetContainerService sets the ContainerService field's value.

func (CreateContainerServiceDeploymentOutput) String added in v1.35.27 

func (s CreateContainerServiceDeploymentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateContainerServiceInput added in v1.35.27 

type CreateContainerServiceInput struct {

	// An object that describes a deployment for the container service.
	//
	// A deployment specifies the containers that will be launched on the container
	// service and their settings, such as the ports to open, the environment variables
	// to apply, and the launch command to run. It also specifies the container
	// that will serve as the public endpoint of the deployment and its settings,
	// such as the HTTP or HTTPS port to use, and the health check configuration.
	Deployment *ContainerServiceDeploymentRequest `locationName:"deployment" type:"structure"`

	// The power specification for the container service.
	//
	// The power specifies the amount of memory, vCPUs, and base monthly cost of
	// each node of the container service. The power and scale of a container service
	// makes up its configured capacity. To determine the monthly price of your
	// container service, multiply the base price of the power with the scale (the
	// number of nodes) of the service.
	//
	// Use the GetContainerServicePowers action to get a list of power options that
	// you can specify using this parameter, and their base monthly cost.
	//
	// Power is a required field
	Power *string `locationName:"power" type:"string" required:"true" enum:"ContainerServicePowerName"`

	// An object to describe the configuration for the container service to access
	// private container image repositories, such as Amazon Elastic Container Registry
	// (Amazon ECR) private repositories.
	//
	// For more information, see Configuring access to an Amazon ECR private repository
	// for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access)
	// in the Amazon Lightsail Developer Guide.
	PrivateRegistryAccess *PrivateRegistryAccessRequest `locationName:"privateRegistryAccess" type:"structure"`

	// The public domain names to use with the container service, such as example.com
	// and www.example.com.
	//
	// You can specify up to four public domain names for a container service. The
	// domain names that you specify are used when you create a deployment with
	// a container configured as the public endpoint of your container service.
	//
	// If you don't specify public domain names, then you can use the default domain
	// of the container service.
	//
	// You must create and validate an SSL/TLS certificate before you can use public
	// domain names with your container service. Use the CreateCertificate action
	// to create a certificate for the public domain names you want to use with
	// your container service.
	//
	// You can specify public domain names using a string to array map as shown
	// in the example later on this page.
	PublicDomainNames map[string][]*string `locationName:"publicDomainNames" type:"map"`

	// The scale specification for the container service.
	//
	// The scale specifies the allocated compute nodes of the container service.
	// The power and scale of a container service makes up its configured capacity.
	// To determine the monthly price of your container service, multiply the base
	// price of the power with the scale (the number of nodes) of the service.
	//
	// Scale is a required field
	Scale *int64 `locationName:"scale" min:"1" type:"integer" required:"true"`

	// The name for the container service.
	//
	// The name that you specify for your container service will make up part of
	// its default domain. The default domain of a container service is typically
	// https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com. If
	// the name of your container service is container-service-1, and it's located
	// in the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain
	// for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com
	//
	// The following are the requirements for container service names:
	//
	//    * Must be unique within each Amazon Web Services Region in your Lightsail
	//    account.
	//
	//    * Must contain 1 to 63 characters.
	//
	//    * Must contain only alphanumeric characters and hyphens.
	//
	//    * A hyphen (-) can separate words but cannot be at the start or end of
	//    the name.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`

	// The tag keys and optional values to add to the container service during create.
	//
	// Use the TagResource action to tag a resource after it's created.
	//
	// For more information about tags in Lightsail, see the Amazon Lightsail Developer
	// Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateContainerServiceInput) GoString added in v1.35.27 

func (s CreateContainerServiceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerServiceInput) SetDeployment added in v1.35.27 

func (s *CreateContainerServiceInput) SetDeployment(v *ContainerServiceDeploymentRequest) *CreateContainerServiceInput

SetDeployment sets the Deployment field's value.

func (*CreateContainerServiceInput) SetPower added in v1.35.27 

func (s *CreateContainerServiceInput) SetPower(v string) *CreateContainerServiceInput

SetPower sets the Power field's value.

func (*CreateContainerServiceInput) SetPrivateRegistryAccess added in v1.44.23 

func (s *CreateContainerServiceInput) SetPrivateRegistryAccess(v *PrivateRegistryAccessRequest) *CreateContainerServiceInput

SetPrivateRegistryAccess sets the PrivateRegistryAccess field's value.

func (*CreateContainerServiceInput) SetPublicDomainNames added in v1.35.27 

func (s *CreateContainerServiceInput) SetPublicDomainNames(v map[string][]*string) *CreateContainerServiceInput

SetPublicDomainNames sets the PublicDomainNames field's value.

func (*CreateContainerServiceInput) SetScale added in v1.35.27 

func (s *CreateContainerServiceInput) SetScale(v int64) *CreateContainerServiceInput

SetScale sets the Scale field's value.

func (*CreateContainerServiceInput) SetServiceName added in v1.35.27 

func (s *CreateContainerServiceInput) SetServiceName(v string) *CreateContainerServiceInput

SetServiceName sets the ServiceName field's value.

func (*CreateContainerServiceInput) SetTags added in v1.35.27 

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

SetTags sets the Tags field's value.

func (CreateContainerServiceInput) String added in v1.35.27 

func (s CreateContainerServiceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerServiceInput) Validate added in v1.35.27 

func (s *CreateContainerServiceInput) Validate() error

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

type CreateContainerServiceOutput added in v1.35.27 

type CreateContainerServiceOutput struct {

	// An object that describes a container service.
	ContainerService *ContainerService `locationName:"containerService" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateContainerServiceOutput) GoString added in v1.35.27 

func (s CreateContainerServiceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerServiceOutput) SetContainerService added in v1.35.27 

func (s *CreateContainerServiceOutput) SetContainerService(v *ContainerService) *CreateContainerServiceOutput

SetContainerService sets the ContainerService field's value.

func (CreateContainerServiceOutput) String added in v1.35.27 

func (s CreateContainerServiceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateContainerServiceRegistryLoginInput added in v1.35.27 

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

func (CreateContainerServiceRegistryLoginInput) GoString added in v1.35.27 

func (s CreateContainerServiceRegistryLoginInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateContainerServiceRegistryLoginInput) String added in v1.35.27 

func (s CreateContainerServiceRegistryLoginInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateContainerServiceRegistryLoginOutput added in v1.35.27 

type CreateContainerServiceRegistryLoginOutput struct {

	// An object that describes the log in information for the container service
	// registry of your Lightsail account.
	RegistryLogin *ContainerServiceRegistryLogin `locationName:"registryLogin" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateContainerServiceRegistryLoginOutput) GoString added in v1.35.27 

func (s CreateContainerServiceRegistryLoginOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateContainerServiceRegistryLoginOutput) SetRegistryLogin added in v1.35.27 

func (s *CreateContainerServiceRegistryLoginOutput) SetRegistryLogin(v *ContainerServiceRegistryLogin) *CreateContainerServiceRegistryLoginOutput

SetRegistryLogin sets the RegistryLogin field's value.

func (CreateContainerServiceRegistryLoginOutput) String added in v1.35.27 

func (s CreateContainerServiceRegistryLoginOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDiskFromSnapshotInput added in v1.12.27 

type CreateDiskFromSnapshotInput struct {

	// An array of objects that represent the add-ons to enable for the new disk.
	AddOns []*AddOnRequest `locationName:"addOns" type:"list"`

	// 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.
	//
	// Constraint:
	//
	//    * This parameter cannot be defined together with the source disk name
	//    parameter. The disk snapshot name and source disk name parameters are
	//    mutually exclusive.
	DiskSnapshotName *string `locationName:"diskSnapshotName" type:"string"`

	// The date of the automatic snapshot to use for the new disk. Use the get auto
	// snapshots operation to identify the dates of the available automatic snapshots.
	//
	// Constraints:
	//
	//    * Must be specified in YYYY-MM-DD format.
	//
	//    * This parameter cannot be defined together with the use latest restorable
	//    auto snapshot parameter. The restore date and use latest restorable auto
	//    snapshot parameters are mutually exclusive.
	//
	//    * Define this parameter only when creating a new disk from an automatic
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	RestoreDate *string `locationName:"restoreDate" type:"string"`

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

	// The name of the source disk from which the source automatic snapshot was
	// created.
	//
	// Constraints:
	//
	//    * This parameter cannot be defined together with the disk snapshot name
	//    parameter. The source disk name and disk snapshot name parameters are
	//    mutually exclusive.
	//
	//    * Define this parameter only when creating a new disk from an automatic
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	SourceDiskName *string `locationName:"sourceDiskName" type:"string"`

	// The tag keys and optional values to add to the resource during create.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`

	// A Boolean value to indicate whether to use the latest available automatic
	// snapshot.
	//
	// Constraints:
	//
	//    * This parameter cannot be defined together with the restore date parameter.
	//    The use latest restorable auto snapshot and restore date parameters are
	//    mutually exclusive.
	//
	//    * Define this parameter only when creating a new disk from an automatic
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	UseLatestRestorableAutoSnapshot *bool `locationName:"useLatestRestorableAutoSnapshot" type:"boolean"`
	// contains filtered or unexported fields
}

func (CreateDiskFromSnapshotInput) GoString added in v1.12.27 

func (s CreateDiskFromSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDiskFromSnapshotInput) SetAddOns added in v1.25.4 

func (s *CreateDiskFromSnapshotInput) SetAddOns(v []*AddOnRequest) *CreateDiskFromSnapshotInput

SetAddOns sets the AddOns field's value.

func (*CreateDiskFromSnapshotInput) SetAvailabilityZone added in v1.12.27 

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateDiskFromSnapshotInput) SetDiskName added in v1.12.27 

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

SetDiskName sets the DiskName field's value.

func (*CreateDiskFromSnapshotInput) SetDiskSnapshotName added in v1.12.27 

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

SetDiskSnapshotName sets the DiskSnapshotName field's value.

func (*CreateDiskFromSnapshotInput) SetRestoreDate added in v1.25.4 

func (s *CreateDiskFromSnapshotInput) SetRestoreDate(v string) *CreateDiskFromSnapshotInput

SetRestoreDate sets the RestoreDate field's value.

func (*CreateDiskFromSnapshotInput) SetSizeInGb added in v1.12.27 

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

SetSizeInGb sets the SizeInGb field's value.

func (*CreateDiskFromSnapshotInput) SetSourceDiskName added in v1.25.4 

func (s *CreateDiskFromSnapshotInput) SetSourceDiskName(v string) *CreateDiskFromSnapshotInput

SetSourceDiskName sets the SourceDiskName field's value.

func (*CreateDiskFromSnapshotInput) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (*CreateDiskFromSnapshotInput) SetUseLatestRestorableAutoSnapshot added in v1.25.4 

func (s *CreateDiskFromSnapshotInput) SetUseLatestRestorableAutoSnapshot(v bool) *CreateDiskFromSnapshotInput

SetUseLatestRestorableAutoSnapshot sets the UseLatestRestorableAutoSnapshot field's value.

func (CreateDiskFromSnapshotInput) String added in v1.12.27 

func (s CreateDiskFromSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDiskFromSnapshotOutput) SetOperations added in v1.12.27 

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

SetOperations sets the Operations field's value.

func (CreateDiskFromSnapshotOutput) String added in v1.12.27 

func (s CreateDiskFromSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDiskInput added in v1.12.27 

type CreateDiskInput struct {

	// An array of objects that represent the add-ons to enable for the new disk.
	AddOns []*AddOnRequest `locationName:"addOns" type:"list"`

	// The Availability Zone where you want to create the disk (e.g., us-east-2a).
	// Use the same Availability Zone as the Lightsail instance to which you want
	// to attach the disk.
	//
	// Use the get regions operation to list the Availability Zones where Lightsail
	// is currently available.
	//
	// 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.
	//
	// Use the TagResource action to tag a resource after it's created.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDiskInput) SetAddOns added in v1.25.4 

func (s *CreateDiskInput) SetAddOns(v []*AddOnRequest) *CreateDiskInput

SetAddOns sets the AddOns field's value.

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Use the TagResource action to tag a resource after it's created.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDiskSnapshotInput) SetDiskName added in v1.12.27 

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

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

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

SetInstanceName sets the InstanceName field's value.

func (*CreateDiskSnapshotInput) SetTags added in v1.15.86 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDiskSnapshotOutput) SetOperations added in v1.12.27 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDistributionInput added in v1.33.11 

type CreateDistributionInput struct {

	// The bundle ID to use for the distribution.
	//
	// A distribution bundle describes the specifications of your distribution,
	// such as the monthly cost and monthly network transfer quota.
	//
	// Use the GetDistributionBundles action to get a list of distribution bundle
	// IDs that you can specify.
	//
	// BundleId is a required field
	BundleId *string `locationName:"bundleId" type:"string" required:"true"`

	// An object that describes the cache behavior settings for the distribution.
	CacheBehaviorSettings *CacheSettings `locationName:"cacheBehaviorSettings" type:"structure"`

	// An array of objects that describe the per-path cache behavior for the distribution.
	CacheBehaviors []*CacheBehaviorPerPath `locationName:"cacheBehaviors" type:"list"`

	// An object that describes the default cache behavior for the distribution.
	//
	// DefaultCacheBehavior is a required field
	DefaultCacheBehavior *CacheBehavior `locationName:"defaultCacheBehavior" type:"structure" required:"true"`

	// The name for the distribution.
	//
	// DistributionName is a required field
	DistributionName *string `locationName:"distributionName" type:"string" required:"true"`

	// The IP address type for the distribution.
	//
	// The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	//
	// The default value is dualstack.
	IpAddressType *string `locationName:"ipAddressType" type:"string" enum:"IpAddressType"`

	// An object that describes the origin resource for the distribution, such as
	// a Lightsail instance, bucket, or load balancer.
	//
	// The distribution pulls, caches, and serves content from the origin.
	//
	// Origin is a required field
	Origin *InputOrigin `locationName:"origin" type:"structure" required:"true"`

	// The tag keys and optional values to add to the distribution during create.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDistributionInput) GoString added in v1.33.11 

func (s CreateDistributionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDistributionInput) SetBundleId added in v1.33.11 

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

SetBundleId sets the BundleId field's value.

func (*CreateDistributionInput) SetCacheBehaviorSettings added in v1.33.11 

func (s *CreateDistributionInput) SetCacheBehaviorSettings(v *CacheSettings) *CreateDistributionInput

SetCacheBehaviorSettings sets the CacheBehaviorSettings field's value.

func (*CreateDistributionInput) SetCacheBehaviors added in v1.33.11 

func (s *CreateDistributionInput) SetCacheBehaviors(v []*CacheBehaviorPerPath) *CreateDistributionInput

SetCacheBehaviors sets the CacheBehaviors field's value.

func (*CreateDistributionInput) SetDefaultCacheBehavior added in v1.33.11 

func (s *CreateDistributionInput) SetDefaultCacheBehavior(v *CacheBehavior) *CreateDistributionInput

SetDefaultCacheBehavior sets the DefaultCacheBehavior field's value.

func (*CreateDistributionInput) SetDistributionName added in v1.33.11 

func (s *CreateDistributionInput) SetDistributionName(v string) *CreateDistributionInput

SetDistributionName sets the DistributionName field's value.

func (*CreateDistributionInput) SetIpAddressType added in v1.36.25 

func (s *CreateDistributionInput) SetIpAddressType(v string) *CreateDistributionInput

SetIpAddressType sets the IpAddressType field's value.

func (*CreateDistributionInput) SetOrigin added in v1.33.11 

func (s *CreateDistributionInput) SetOrigin(v *InputOrigin) *CreateDistributionInput

SetOrigin sets the Origin field's value.

func (*CreateDistributionInput) SetTags added in v1.33.11 

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

SetTags sets the Tags field's value.

func (CreateDistributionInput) String added in v1.33.11 

func (s CreateDistributionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDistributionInput) Validate added in v1.33.11 

func (s *CreateDistributionInput) Validate() error

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

type CreateDistributionOutput added in v1.33.11 

type CreateDistributionOutput struct {

	// An object that describes the distribution created.
	Distribution *LightsailDistribution `locationName:"distribution" type:"structure"`

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDistributionOutput) GoString added in v1.33.11 

func (s CreateDistributionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDistributionOutput) SetDistribution added in v1.33.11 

func (s *CreateDistributionOutput) SetDistribution(v *LightsailDistribution) *CreateDistributionOutput

SetDistribution sets the Distribution field's value.

func (*CreateDistributionOutput) SetOperation added in v1.33.11 

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

SetOperation sets the Operation field's value.

func (CreateDistributionOutput) String added in v1.33.11 

func (s CreateDistributionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainEntryInput) SetDomainEntry 

func (s *CreateDomainEntryInput) SetDomainEntry(v *DomainEntry) *CreateDomainEntryInput

SetDomainEntry sets the DomainEntry field's value.

func (*CreateDomainEntryInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (CreateDomainEntryInput) String 

func (s CreateDomainEntryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDomainEntryOutput) GoString 

func (s CreateDomainEntryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainEntryOutput) SetOperation 

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

SetOperation sets the Operation field's value.

func (CreateDomainEntryOutput) String 

func (s CreateDomainEntryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDomainInput 

type CreateDomainInput struct {

	// The domain name to manage (e.g., example.com).
	//
	// 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.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateDomainInput) GoString 

func (s CreateDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (*CreateDomainInput) SetTags added in v1.15.86 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDomainOutput) GoString 

func (s CreateDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInstanceSnapshotInput) GoString 

func (s CreateInstanceSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInstanceSnapshotInput) SetInstanceName 

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

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

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

SetTags sets the Tags field's value.

func (CreateInstanceSnapshotInput) String 

func (s CreateInstanceSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInstanceSnapshotOutput) GoString 

func (s CreateInstanceSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInstanceSnapshotOutput) SetOperations 

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

SetOperations sets the Operations field's value.

func (CreateInstanceSnapshotOutput) String 

func (s CreateInstanceSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateInstancesFromSnapshotInput 

type CreateInstancesFromSnapshotInput struct {

	// An array of objects representing the add-ons to enable for the new instance.
	AddOns []*AddOnRequest `locationName:"addOns" type:"list"`

	// 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.
	//
	// Constraint:
	//
	//    * This parameter cannot be defined together with the source instance name
	//    parameter. The instance snapshot name and source instance name parameters
	//    are mutually exclusive.
	InstanceSnapshotName *string `locationName:"instanceSnapshotName" type:"string"`

	// The IP address type for the instance.
	//
	// The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	//
	// The default value is dualstack.
	IpAddressType *string `locationName:"ipAddressType" type:"string" enum:"IpAddressType"`

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

	// The date of the automatic snapshot to use for the new instance. Use the get
	// auto snapshots operation to identify the dates of the available automatic
	// snapshots.
	//
	// Constraints:
	//
	//    * Must be specified in YYYY-MM-DD format.
	//
	//    * This parameter cannot be defined together with the use latest restorable
	//    auto snapshot parameter. The restore date and use latest restorable auto
	//    snapshot parameters are mutually exclusive.
	//
	//    * Define this parameter only when creating a new instance from an automatic
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	RestoreDate *string `locationName:"restoreDate" type:"string"`

	// The name of the source instance from which the source automatic snapshot
	// was created.
	//
	// Constraints:
	//
	//    * This parameter cannot be defined together with the instance snapshot
	//    name parameter. The source instance name and instance snapshot name parameters
	//    are mutually exclusive.
	//
	//    * Define this parameter only when creating a new instance from an automatic
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	SourceInstanceName *string `locationName:"sourceInstanceName" type:"string"`

	// The tag keys and optional values to add to the resource during create.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`

	// A Boolean value to indicate whether to use the latest available automatic
	// snapshot.
	//
	// Constraints:
	//
	//    * This parameter cannot be defined together with the restore date parameter.
	//    The use latest restorable auto snapshot and restore date parameters are
	//    mutually exclusive.
	//
	//    * Define this parameter only when creating a new instance from an automatic
	//    snapshot. For more information, see the Amazon Lightsail Developer Guide
	//    (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
	UseLatestRestorableAutoSnapshot *bool `locationName:"useLatestRestorableAutoSnapshot" type:"boolean"`

	// You can create a launch script that configures a server with additional user
	// data. For example, apt-get -y update.
	//
	// Depending on the machine image you choose, the command to get software on
	// your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu
	// use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail
	// Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image).
	UserData *string `locationName:"userData" type:"string"`
	// contains filtered or unexported fields
}

func (CreateInstancesFromSnapshotInput) GoString 

func (s CreateInstancesFromSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInstancesFromSnapshotInput) SetAddOns added in v1.25.4 

func (s *CreateInstancesFromSnapshotInput) SetAddOns(v []*AddOnRequest) *CreateInstancesFromSnapshotInput

SetAddOns sets the AddOns field's value.

func (*CreateInstancesFromSnapshotInput) SetAttachedDiskMapping added in v1.12.27 

func (s *CreateInstancesFromSnapshotInput) SetAttachedDiskMapping(v map[string][]*DiskMap) *CreateInstancesFromSnapshotInput

SetAttachedDiskMapping sets the AttachedDiskMapping field's value.

func (*CreateInstancesFromSnapshotInput) SetAvailabilityZone 

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateInstancesFromSnapshotInput) SetBundleId 

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

SetBundleId sets the BundleId field's value.

func (*CreateInstancesFromSnapshotInput) SetInstanceNames 

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

SetInstanceNames sets the InstanceNames field's value.

func (*CreateInstancesFromSnapshotInput) SetInstanceSnapshotName 

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

SetInstanceSnapshotName sets the InstanceSnapshotName field's value.

func (*CreateInstancesFromSnapshotInput) SetIpAddressType added in v1.36.25 

func (s *CreateInstancesFromSnapshotInput) SetIpAddressType(v string) *CreateInstancesFromSnapshotInput

SetIpAddressType sets the IpAddressType field's value.

func (*CreateInstancesFromSnapshotInput) SetKeyPairName 

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

SetKeyPairName sets the KeyPairName field's value.

func (*CreateInstancesFromSnapshotInput) SetRestoreDate added in v1.25.4 

func (s *CreateInstancesFromSnapshotInput) SetRestoreDate(v string) *CreateInstancesFromSnapshotInput

SetRestoreDate sets the RestoreDate field's value.

func (*CreateInstancesFromSnapshotInput) SetSourceInstanceName added in v1.25.4 

func (s *CreateInstancesFromSnapshotInput) SetSourceInstanceName(v string) *CreateInstancesFromSnapshotInput

SetSourceInstanceName sets the SourceInstanceName field's value.

func (*CreateInstancesFromSnapshotInput) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (*CreateInstancesFromSnapshotInput) SetUseLatestRestorableAutoSnapshot added in v1.25.4 

func (s *CreateInstancesFromSnapshotInput) SetUseLatestRestorableAutoSnapshot(v bool) *CreateInstancesFromSnapshotInput

SetUseLatestRestorableAutoSnapshot sets the UseLatestRestorableAutoSnapshot field's value.

func (*CreateInstancesFromSnapshotInput) SetUserData 

func (s *CreateInstancesFromSnapshotInput) SetUserData(v string) *CreateInstancesFromSnapshotInput

SetUserData sets the UserData field's value.

func (CreateInstancesFromSnapshotInput) String 

func (s CreateInstancesFromSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInstancesFromSnapshotInput) Validate 

func (s *CreateInstancesFromSnapshotInput) Validate() error

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

type CreateInstancesFromSnapshotOutput 

type CreateInstancesFromSnapshotOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInstancesFromSnapshotOutput) GoString 

func (s CreateInstancesFromSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInstancesFromSnapshotOutput) SetOperations 

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

SetOperations sets the Operations field's value.

func (CreateInstancesFromSnapshotOutput) String 

func (s CreateInstancesFromSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateInstancesInput 

type CreateInstancesInput struct {

	// An array of objects representing the add-ons to enable for the new instance.
	AddOns []*AddOnRequest `locationName:"addOns" type:"list"`

	// 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).
	//
	// Use active blueprints when creating new instances. Inactive blueprints are
	// listed to support customers with existing instances and are not necessarily
	// available to create new instances. Blueprints are marked inactive when they
	// become outdated due to operating system updates or new application releases.
	//
	// 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 IP address type for the instance.
	//
	// The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	//
	// The default value is dualstack.
	IpAddressType *string `locationName:"ipAddressType" type:"string" enum:"IpAddressType"`

	// 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.
	//
	// Use the TagResource action to tag a resource after it's created.
	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 Amazon Lightsail
	// Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateInstancesInput) SetAddOns added in v1.25.4 

func (s *CreateInstancesInput) SetAddOns(v []*AddOnRequest) *CreateInstancesInput

SetAddOns sets the AddOns field's value.

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 

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

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) SetIpAddressType added in v1.36.25 

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

SetIpAddressType sets the IpAddressType 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.15.86 

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

SetTags sets the Tags field's value.

func (*CreateInstancesInput) SetUserData 

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

SetUserData sets the UserData field's value.

func (CreateInstancesInput) String 

func (s CreateInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateInstancesOutput) GoString 

func (s CreateInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateKeyPairInput) GoString 

func (s CreateKeyPairInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeyPairInput) SetKeyPairName 

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

SetKeyPairName sets the KeyPairName field's value.

func (*CreateKeyPairInput) SetTags added in v1.15.86 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 IP address type for the load balancer.
	//
	// The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	//
	// The default value is dualstack.
	IpAddressType *string `locationName:"ipAddressType" type:"string" enum:"IpAddressType"`

	// 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.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`

	// The name of the TLS policy to apply to the load balancer.
	//
	// Use the GetLoadBalancerTlsPolicies (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html)
	// action to get a list of TLS policy names that you can specify.
	//
	// For more information about load balancer TLS policies, see Configuring TLS
	// security policies on your Amazon Lightsail load balancers (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy)
	// in the Amazon Lightsail Developer Guide.
	TlsPolicyName *string `locationName:"tlsPolicyName" type:"string"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerInput) GoString added in v1.12.37 

func (s CreateLoadBalancerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIpAddressType added in v1.36.25 

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

SetIpAddressType sets the IpAddressType 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.15.86 

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

SetTags sets the Tags field's value.

func (*CreateLoadBalancerInput) SetTlsPolicyName added in v1.44.1 

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

SetTlsPolicyName sets the TlsPolicyName field's value.

func (CreateLoadBalancerInput) String added in v1.12.37 

func (s CreateLoadBalancerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLoadBalancerOutput) SetOperations added in v1.12.37 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerTlsCertificateInput) GoString added in v1.12.37 

func (s CreateLoadBalancerTlsCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLoadBalancerTlsCertificateInput) SetCertificateAlternativeNames added in v1.12.37 

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

SetCertificateAlternativeNames sets the CertificateAlternativeNames field's value.

func (*CreateLoadBalancerTlsCertificateInput) SetCertificateDomainName added in v1.12.37 

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

SetCertificateDomainName sets the CertificateDomainName field's value.

func (*CreateLoadBalancerTlsCertificateInput) SetCertificateName added in v1.12.37 

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

SetCertificateName sets the CertificateName field's value.

func (*CreateLoadBalancerTlsCertificateInput) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*CreateLoadBalancerTlsCertificateInput) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (CreateLoadBalancerTlsCertificateInput) String added in v1.12.37 

func (s CreateLoadBalancerTlsCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLoadBalancerTlsCertificateInput) Validate added in v1.12.37 

func (s *CreateLoadBalancerTlsCertificateInput) Validate() error

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

type CreateLoadBalancerTlsCertificateOutput added in v1.12.37 

type CreateLoadBalancerTlsCertificateOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateLoadBalancerTlsCertificateOutput) GoString added in v1.12.37 

func (s CreateLoadBalancerTlsCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLoadBalancerTlsCertificateOutput) SetOperations added in v1.12.37 

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

SetOperations sets the Operations field's value.

func (CreateLoadBalancerTlsCertificateOutput) String added in v1.12.37 

func (s CreateLoadBalancerTlsCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRelationalDatabaseFromSnapshotInput added in v1.15.56 

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 Lightsail database resource.
	//
	// Constraints:
	//
	//    * Must contain from 2 to 255 alphanumeric characters, or hyphens.
	//
	//    * The first and last character must be a letter or number.
	//
	// 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 Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use a
	//    restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000
	//    as the restore time.
	RestoreTime *time.Time `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.
	//
	// Use the TagResource action to tag a resource after it's created.
	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.15.56 

func (s CreateRelationalDatabaseFromSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseFromSnapshotInput) SetAvailabilityZone added in v1.15.56 

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetPubliclyAccessible added in v1.15.56 

func (s *CreateRelationalDatabaseFromSnapshotInput) SetPubliclyAccessible(v bool) *CreateRelationalDatabaseFromSnapshotInput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetRelationalDatabaseBundleId added in v1.15.56 

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

SetRelationalDatabaseBundleId sets the RelationalDatabaseBundleId field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetRelationalDatabaseSnapshotName added in v1.15.56 

func (s *CreateRelationalDatabaseFromSnapshotInput) SetRelationalDatabaseSnapshotName(v string) *CreateRelationalDatabaseFromSnapshotInput

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetRestoreTime added in v1.15.56 

func (s *CreateRelationalDatabaseFromSnapshotInput) SetRestoreTime(v time.Time) *CreateRelationalDatabaseFromSnapshotInput

SetRestoreTime sets the RestoreTime field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetSourceRelationalDatabaseName added in v1.15.56 

func (s *CreateRelationalDatabaseFromSnapshotInput) SetSourceRelationalDatabaseName(v string) *CreateRelationalDatabaseFromSnapshotInput

SetSourceRelationalDatabaseName sets the SourceRelationalDatabaseName field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (*CreateRelationalDatabaseFromSnapshotInput) SetUseLatestRestorableTime added in v1.15.56 

func (s *CreateRelationalDatabaseFromSnapshotInput) SetUseLatestRestorableTime(v bool) *CreateRelationalDatabaseFromSnapshotInput

SetUseLatestRestorableTime sets the UseLatestRestorableTime field's value.

func (CreateRelationalDatabaseFromSnapshotInput) String added in v1.15.56 

func (s CreateRelationalDatabaseFromSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseFromSnapshotInput) Validate added in v1.15.56 

func (s *CreateRelationalDatabaseFromSnapshotInput) Validate() error

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

type CreateRelationalDatabaseFromSnapshotOutput added in v1.15.56 

type CreateRelationalDatabaseFromSnapshotOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseFromSnapshotOutput) GoString added in v1.15.56 

func (s CreateRelationalDatabaseFromSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseFromSnapshotOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (CreateRelationalDatabaseFromSnapshotOutput) String added in v1.15.56 

func (s CreateRelationalDatabaseFromSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRelationalDatabaseInput added in v1.15.56 

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 meaning of this parameter differs according to the database engine you
	// use.
	//
	// MySQL
	//
	// The name of the database to create when the Lightsail database resource is
	// created. If this parameter isn't specified, no database is created in the
	// database resource.
	//
	// Constraints:
	//
	//    * Must contain 1 to 64 letters or numbers.
	//
	//    * Must begin with a letter. Subsequent characters can be letters, underscores,
	//    or digits (0- 9).
	//
	//    * Can't be a word reserved by the specified database engine. For more
	//    information about reserved words in MySQL, see the Keywords and Reserved
	//    Words articles for MySQL 5.6 (https://dev.mysql.com/doc/refman/5.6/en/keywords.html),
	//    MySQL 5.7 (https://dev.mysql.com/doc/refman/5.7/en/keywords.html), and
	//    MySQL 8.0 (https://dev.mysql.com/doc/refman/8.0/en/keywords.html).
	//
	// PostgreSQL
	//
	// The name of the database to create when the Lightsail database resource is
	// created. If this parameter isn't specified, a database named postgres is
	// created in the database resource.
	//
	// Constraints:
	//
	//    * Must contain 1 to 63 letters or numbers.
	//
	//    * Must begin with a letter. Subsequent characters can be letters, underscores,
	//    or digits (0- 9).
	//
	//    * Can't be a word reserved by the specified database engine. For more
	//    information about reserved words in PostgreSQL, see the SQL Key Words
	//    articles for PostgreSQL 9.6 (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html),
	//    PostgreSQL 10 (https://www.postgresql.org/docs/10/sql-keywords-appendix.html),
	//    PostgreSQL 11 (https://www.postgresql.org/docs/11/sql-keywords-appendix.html),
	//    and PostgreSQL 12 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html).
	//
	// MasterDatabaseName is a required field
	MasterDatabaseName *string `locationName:"masterDatabaseName" type:"string" required:"true"`

	// The password for the master user. The password can include any printable
	// ASCII character except "/", """, or "@". It cannot contain spaces.
	//
	// MySQL
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// PostgreSQL
	//
	// Constraints: Must contain from 8 to 128 characters.
	//
	// MasterUserPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateRelationalDatabaseInput's
	// String and GoString methods.
	MasterUserPassword *string `locationName:"masterUserPassword" type:"string" sensitive:"true"`

	// The name for the master user.
	//
	// MySQL
	//
	// Constraints:
	//
	//    * Required for MySQL.
	//
	//    * Must be 1 to 16 letters or numbers. Can contain underscores.
	//
	//    * First character must be a letter.
	//
	//    * Can't be a reserved word for the chosen database engine. For more information
	//    about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved
	//    Words articles for MySQL 5.6 (https://dev.mysql.com/doc/refman/5.6/en/keywords.html),
	//    MySQL 5.7 (https://dev.mysql.com/doc/refman/5.7/en/keywords.html), or
	//    MySQL 8.0 (https://dev.mysql.com/doc/refman/8.0/en/keywords.html).
	//
	// PostgreSQL
	//
	// Constraints:
	//
	//    * Required for PostgreSQL.
	//
	//    * Must be 1 to 63 letters or numbers. Can contain underscores.
	//
	//    * First character must be a letter.
	//
	//    * Can't be a reserved word for the chosen database engine. For more information
	//    about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved
	//    Words articles for PostgreSQL 9.6 (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html),
	//    PostgreSQL 10 (https://www.postgresql.org/docs/10/sql-keywords-appendix.html),
	//    PostgreSQL 11 (https://www.postgresql.org/docs/11/sql-keywords-appendix.html),
	//    and PostgreSQL 12 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html).
	//
	// 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 documentation.
	//
	// Constraints:
	//
	//    * Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `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 Coordinated Universal 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 Lightsail database resource.
	//
	// Constraints:
	//
	//    * Must contain from 2 to 255 alphanumeric characters, or hyphens.
	//
	//    * The first and last character must be a letter or number.
	//
	// 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.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseInput) GoString added in v1.15.56 

func (s CreateRelationalDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseInput) SetAvailabilityZone added in v1.15.56 

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateRelationalDatabaseInput) SetMasterDatabaseName added in v1.15.56 

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

SetMasterDatabaseName sets the MasterDatabaseName field's value.

func (*CreateRelationalDatabaseInput) SetMasterUserPassword added in v1.15.56 

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

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*CreateRelationalDatabaseInput) SetMasterUsername added in v1.15.56 

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

SetMasterUsername sets the MasterUsername field's value.

func (*CreateRelationalDatabaseInput) SetPreferredBackupWindow added in v1.15.56 

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*CreateRelationalDatabaseInput) SetPreferredMaintenanceWindow added in v1.15.56 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateRelationalDatabaseInput) SetPubliclyAccessible added in v1.15.56 

func (s *CreateRelationalDatabaseInput) SetPubliclyAccessible(v bool) *CreateRelationalDatabaseInput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateRelationalDatabaseInput) SetRelationalDatabaseBlueprintId added in v1.15.56 

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

SetRelationalDatabaseBlueprintId sets the RelationalDatabaseBlueprintId field's value.

func (*CreateRelationalDatabaseInput) SetRelationalDatabaseBundleId added in v1.15.56 

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

SetRelationalDatabaseBundleId sets the RelationalDatabaseBundleId field's value.

func (*CreateRelationalDatabaseInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*CreateRelationalDatabaseInput) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (CreateRelationalDatabaseInput) String added in v1.15.56 

func (s CreateRelationalDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseInput) Validate added in v1.15.56 

func (s *CreateRelationalDatabaseInput) Validate() error

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

type CreateRelationalDatabaseOutput added in v1.15.56 

type CreateRelationalDatabaseOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseOutput) GoString added in v1.15.56 

func (s CreateRelationalDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (CreateRelationalDatabaseOutput) String added in v1.15.56 

func (s CreateRelationalDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRelationalDatabaseSnapshotInput added in v1.15.56 

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.
	//
	// Use the TagResource action to tag a resource after it's created.
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseSnapshotInput) GoString added in v1.15.56 

func (s CreateRelationalDatabaseSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseSnapshotInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*CreateRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName added in v1.15.56 

func (s *CreateRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName(v string) *CreateRelationalDatabaseSnapshotInput

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (*CreateRelationalDatabaseSnapshotInput) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (CreateRelationalDatabaseSnapshotInput) String added in v1.15.56 

func (s CreateRelationalDatabaseSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseSnapshotInput) Validate added in v1.15.56 

func (s *CreateRelationalDatabaseSnapshotInput) Validate() error

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

type CreateRelationalDatabaseSnapshotOutput added in v1.15.56 

type CreateRelationalDatabaseSnapshotOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (CreateRelationalDatabaseSnapshotOutput) GoString added in v1.15.56 

func (s CreateRelationalDatabaseSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRelationalDatabaseSnapshotOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (CreateRelationalDatabaseSnapshotOutput) String added in v1.15.56 

func (s CreateRelationalDatabaseSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAlarmInput added in v1.29.12 

type DeleteAlarmInput struct {

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

func (DeleteAlarmInput) GoString added in v1.29.12 

func (s DeleteAlarmInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAlarmInput) SetAlarmName added in v1.29.12 

func (s *DeleteAlarmInput) SetAlarmName(v string) *DeleteAlarmInput

SetAlarmName sets the AlarmName field's value.

func (DeleteAlarmInput) String added in v1.29.12 

func (s DeleteAlarmInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAlarmInput) Validate added in v1.29.12 

func (s *DeleteAlarmInput) Validate() error

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

type DeleteAlarmOutput added in v1.29.12 

type DeleteAlarmOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteAlarmOutput) GoString added in v1.29.12 

func (s DeleteAlarmOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAlarmOutput) SetOperations added in v1.29.12 

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

SetOperations sets the Operations field's value.

func (DeleteAlarmOutput) String added in v1.29.12 

func (s DeleteAlarmOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAutoSnapshotInput added in v1.25.4 

type DeleteAutoSnapshotInput struct {

	// The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the
	// get auto snapshots operation to get the available automatic snapshots for
	// a resource.
	//
	// Date is a required field
	Date *string `locationName:"date" type:"string" required:"true"`

	// The name of the source instance or disk from which to delete the automatic
	// snapshot.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAutoSnapshotInput) GoString added in v1.25.4 

func (s DeleteAutoSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAutoSnapshotInput) SetDate added in v1.25.4 

func (s *DeleteAutoSnapshotInput) SetDate(v string) *DeleteAutoSnapshotInput

SetDate sets the Date field's value.

func (*DeleteAutoSnapshotInput) SetResourceName added in v1.25.4 

func (s *DeleteAutoSnapshotInput) SetResourceName(v string) *DeleteAutoSnapshotInput

SetResourceName sets the ResourceName field's value.

func (DeleteAutoSnapshotInput) String added in v1.25.4 

func (s DeleteAutoSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAutoSnapshotInput) Validate added in v1.25.4 

func (s *DeleteAutoSnapshotInput) Validate() error

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

type DeleteAutoSnapshotOutput added in v1.25.4 

type DeleteAutoSnapshotOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteAutoSnapshotOutput) GoString added in v1.25.4 

func (s DeleteAutoSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAutoSnapshotOutput) SetOperations added in v1.25.4 

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

SetOperations sets the Operations field's value.

func (DeleteAutoSnapshotOutput) String added in v1.25.4 

func (s DeleteAutoSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBucketAccessKeyInput added in v1.40.0 

type DeleteBucketAccessKeyInput struct {

	// The ID of the access key to delete.
	//
	// Use the GetBucketAccessKeys (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html)
	// action to get a list of access key IDs that you can specify.
	//
	// AccessKeyId is a required field
	AccessKeyId *string `locationName:"accessKeyId" type:"string" required:"true"`

	// The name of the bucket that the access key belongs to.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBucketAccessKeyInput) GoString added in v1.40.0 

func (s DeleteBucketAccessKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBucketAccessKeyInput) SetAccessKeyId added in v1.40.0 

func (s *DeleteBucketAccessKeyInput) SetAccessKeyId(v string) *DeleteBucketAccessKeyInput

SetAccessKeyId sets the AccessKeyId field's value.

func (*DeleteBucketAccessKeyInput) SetBucketName added in v1.40.0 

func (s *DeleteBucketAccessKeyInput) SetBucketName(v string) *DeleteBucketAccessKeyInput

SetBucketName sets the BucketName field's value.

func (DeleteBucketAccessKeyInput) String added in v1.40.0 

func (s DeleteBucketAccessKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBucketAccessKeyInput) Validate added in v1.40.0 

func (s *DeleteBucketAccessKeyInput) Validate() error

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

type DeleteBucketAccessKeyOutput added in v1.40.0 

type DeleteBucketAccessKeyOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteBucketAccessKeyOutput) GoString added in v1.40.0 

func (s DeleteBucketAccessKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBucketAccessKeyOutput) SetOperations added in v1.40.0 

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

SetOperations sets the Operations field's value.

func (DeleteBucketAccessKeyOutput) String added in v1.40.0 

func (s DeleteBucketAccessKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBucketInput added in v1.40.0 

type DeleteBucketInput struct {

	// The name of the bucket to delete.
	//
	// Use the GetBuckets (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html)
	// action to get a list of bucket names that you can specify.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`

	// A Boolean value that indicates whether to force delete the bucket.
	//
	// You must force delete the bucket if it has one of the following conditions:
	//
	//    * The bucket is the origin of a distribution.
	//
	//    * The bucket has instances that were granted access to it using the SetResourceAccessForBucket
	//    (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html)
	//    action.
	//
	//    * The bucket has objects.
	//
	//    * The bucket has access keys.
	//
	// Force deleting a bucket might impact other resources that rely on the bucket,
	// such as instances, distributions, or software that use the issued access
	// keys.
	ForceDelete *bool `locationName:"forceDelete" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteBucketInput) GoString added in v1.40.0 

func (s DeleteBucketInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBucketInput) SetBucketName added in v1.40.0 

func (s *DeleteBucketInput) SetBucketName(v string) *DeleteBucketInput

SetBucketName sets the BucketName field's value.

func (*DeleteBucketInput) SetForceDelete added in v1.40.0 

func (s *DeleteBucketInput) SetForceDelete(v bool) *DeleteBucketInput

SetForceDelete sets the ForceDelete field's value.

func (DeleteBucketInput) String added in v1.40.0 

func (s DeleteBucketInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBucketInput) Validate added in v1.40.0 

func (s *DeleteBucketInput) Validate() error

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

type DeleteBucketOutput added in v1.40.0 

type DeleteBucketOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteBucketOutput) GoString added in v1.40.0 

func (s DeleteBucketOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBucketOutput) SetOperations added in v1.40.0 

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

SetOperations sets the Operations field's value.

func (DeleteBucketOutput) String added in v1.40.0 

func (s DeleteBucketOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteCertificateInput added in v1.33.11 

type DeleteCertificateInput struct {

	// The name of the certificate to delete.
	//
	// Use the GetCertificates action to get a list of certificate names that you
	// can specify.
	//
	// CertificateName is a required field
	CertificateName *string `locationName:"certificateName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCertificateInput) GoString added in v1.33.11 

func (s DeleteCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCertificateInput) SetCertificateName added in v1.33.11 

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

SetCertificateName sets the CertificateName field's value.

func (DeleteCertificateInput) String added in v1.33.11 

func (s DeleteCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCertificateInput) Validate added in v1.33.11 

func (s *DeleteCertificateInput) Validate() error

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

type DeleteCertificateOutput added in v1.33.11 

type DeleteCertificateOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteCertificateOutput) GoString added in v1.33.11 

func (s DeleteCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteCertificateOutput) SetOperations added in v1.33.11 

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

SetOperations sets the Operations field's value.

func (DeleteCertificateOutput) String added in v1.33.11 

func (s DeleteCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteContactMethodInput added in v1.29.12 

type DeleteContactMethodInput struct {

	// The protocol that will be deleted, such as Email or SMS (text messaging).
	//
	// To delete an Email and an SMS contact method if you added both, you must
	// run separate DeleteContactMethod actions to delete each protocol.
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"ContactProtocol"`
	// contains filtered or unexported fields
}

func (DeleteContactMethodInput) GoString added in v1.29.12 

func (s DeleteContactMethodInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContactMethodInput) SetProtocol added in v1.29.12 

func (s *DeleteContactMethodInput) SetProtocol(v string) *DeleteContactMethodInput

SetProtocol sets the Protocol field's value.

func (DeleteContactMethodInput) String added in v1.29.12 

func (s DeleteContactMethodInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContactMethodInput) Validate added in v1.29.12 

func (s *DeleteContactMethodInput) Validate() error

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

type DeleteContactMethodOutput added in v1.29.12 

type DeleteContactMethodOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteContactMethodOutput) GoString added in v1.29.12 

func (s DeleteContactMethodOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContactMethodOutput) SetOperations added in v1.29.12 

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

SetOperations sets the Operations field's value.

func (DeleteContactMethodOutput) String added in v1.29.12 

func (s DeleteContactMethodOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteContainerImageInput added in v1.35.27 

type DeleteContainerImageInput struct {

	// The name of the container image to delete from the container service.
	//
	// Use the GetContainerImages action to get the name of the container images
	// that are registered to a container service.
	//
	// Container images sourced from your Lightsail container service, that are
	// registered and stored on your service, start with a colon (:). For example,
	// :container-service-1.mystaticwebsite.1. Container images sourced from a public
	// registry like Docker Hub don't start with a colon. For example, nginx:latest
	// or nginx.
	//
	// Image is a required field
	Image *string `locationName:"image" type:"string" required:"true"`

	// The name of the container service for which to delete a registered container
	// image.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteContainerImageInput) GoString added in v1.35.27 

func (s DeleteContainerImageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContainerImageInput) SetImage added in v1.35.27 

func (s *DeleteContainerImageInput) SetImage(v string) *DeleteContainerImageInput

SetImage sets the Image field's value.

func (*DeleteContainerImageInput) SetServiceName added in v1.35.27 

func (s *DeleteContainerImageInput) SetServiceName(v string) *DeleteContainerImageInput

SetServiceName sets the ServiceName field's value.

func (DeleteContainerImageInput) String added in v1.35.27 

func (s DeleteContainerImageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContainerImageInput) Validate added in v1.35.27 

func (s *DeleteContainerImageInput) Validate() error

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

type DeleteContainerImageOutput added in v1.35.27 

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

func (DeleteContainerImageOutput) GoString added in v1.35.27 

func (s DeleteContainerImageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteContainerImageOutput) String added in v1.35.27 

func (s DeleteContainerImageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteContainerServiceInput added in v1.35.27 

type DeleteContainerServiceInput struct {

	// The name of the container service to delete.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteContainerServiceInput) GoString added in v1.35.27 

func (s DeleteContainerServiceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContainerServiceInput) SetServiceName added in v1.35.27 

func (s *DeleteContainerServiceInput) SetServiceName(v string) *DeleteContainerServiceInput

SetServiceName sets the ServiceName field's value.

func (DeleteContainerServiceInput) String added in v1.35.27 

func (s DeleteContainerServiceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteContainerServiceInput) Validate added in v1.35.27 

func (s *DeleteContainerServiceInput) Validate() error

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

type DeleteContainerServiceOutput added in v1.35.27 

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

func (DeleteContainerServiceOutput) GoString added in v1.35.27 

func (s DeleteContainerServiceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteContainerServiceOutput) String added in v1.35.27 

func (s DeleteContainerServiceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// A Boolean value to indicate whether to delete all add-ons for the disk.
	ForceDeleteAddOns *bool `locationName:"forceDeleteAddOns" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteDiskInput) GoString added in v1.12.27 

func (s DeleteDiskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDiskInput) SetDiskName added in v1.12.27 

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

SetDiskName sets the DiskName field's value.

func (*DeleteDiskInput) SetForceDeleteAddOns added in v1.25.4 

func (s *DeleteDiskInput) SetForceDeleteAddOns(v bool) *DeleteDiskInput

SetForceDeleteAddOns sets the ForceDeleteAddOns field's value.

func (DeleteDiskInput) String added in v1.12.27 

func (s DeleteDiskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDiskSnapshotOutput) SetOperations added in v1.12.27 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDistributionInput added in v1.33.11 

type DeleteDistributionInput struct {

	// The name of the distribution to delete.
	//
	// Use the GetDistributions action to get a list of distribution names that
	// you can specify.
	DistributionName *string `locationName:"distributionName" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteDistributionInput) GoString added in v1.33.11 

func (s DeleteDistributionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDistributionInput) SetDistributionName added in v1.33.11 

func (s *DeleteDistributionInput) SetDistributionName(v string) *DeleteDistributionInput

SetDistributionName sets the DistributionName field's value.

func (DeleteDistributionInput) String added in v1.33.11 

func (s DeleteDistributionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDistributionOutput added in v1.33.11 

type DeleteDistributionOutput struct {

	// An object that describes the result of the action, such as the status of
	// the request, the timestamp of the request, and the resources affected by
	// the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDistributionOutput) GoString added in v1.33.11 

func (s DeleteDistributionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDistributionOutput) SetOperation added in v1.33.11 

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

SetOperation sets the Operation field's value.

func (DeleteDistributionOutput) String added in v1.33.11 

func (s DeleteDistributionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainEntryInput) SetDomainEntry 

func (s *DeleteDomainEntryInput) SetDomainEntry(v *DomainEntry) *DeleteDomainEntryInput

SetDomainEntry sets the DomainEntry field's value.

func (*DeleteDomainEntryInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (DeleteDomainEntryInput) String 

func (s DeleteDomainEntryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDomainEntryOutput) GoString 

func (s DeleteDomainEntryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainEntryOutput) SetOperation 

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

SetOperation sets the Operation field's value.

func (DeleteDomainEntryOutput) String 

func (s DeleteDomainEntryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDomainOutput) GoString 

func (s DeleteDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteInstanceInput 

type DeleteInstanceInput struct {

	// A Boolean value to indicate whether to delete all add-ons for the instance.
	ForceDeleteAddOns *bool `locationName:"forceDeleteAddOns" type:"boolean"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInstanceInput) SetForceDeleteAddOns added in v1.25.4 

func (s *DeleteInstanceInput) SetForceDeleteAddOns(v bool) *DeleteInstanceInput

SetForceDeleteAddOns sets the ForceDeleteAddOns field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteInstanceOutput) GoString 

func (s DeleteInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInstanceSnapshotInput) SetInstanceSnapshotName 

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

SetInstanceSnapshotName sets the InstanceSnapshotName field's value.

func (DeleteInstanceSnapshotInput) String 

func (s DeleteInstanceSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteInstanceSnapshotOutput) GoString 

func (s DeleteInstanceSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteInstanceSnapshotOutput) SetOperations 

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

SetOperations sets the Operations field's value.

func (DeleteInstanceSnapshotOutput) String 

func (s DeleteInstanceSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteKeyPairInput 

type DeleteKeyPairInput struct {

	// The RSA fingerprint of the Lightsail default key pair to delete.
	//
	// The expectedFingerprint parameter is required only when specifying to delete
	// a Lightsail default key pair.
	ExpectedFingerprint *string `locationName:"expectedFingerprint" type:"string"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKeyPairInput) SetExpectedFingerprint added in v1.43.6 

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

SetExpectedFingerprint sets the ExpectedFingerprint field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteKeyPairOutput) GoString 

func (s DeleteKeyPairOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteKnownHostKeysInput added in v1.19.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.19.0 

func (s DeleteKnownHostKeysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKnownHostKeysInput) SetInstanceName added in v1.19.0 

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

SetInstanceName sets the InstanceName field's value.

func (DeleteKnownHostKeysInput) String added in v1.19.0 

func (s DeleteKnownHostKeysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKnownHostKeysInput) Validate added in v1.19.0 

func (s *DeleteKnownHostKeysInput) Validate() error

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

type DeleteKnownHostKeysOutput added in v1.19.0 

type DeleteKnownHostKeysOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteKnownHostKeysOutput) GoString added in v1.19.0 

func (s DeleteKnownHostKeysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKnownHostKeysOutput) SetOperations added in v1.19.0 

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

SetOperations sets the Operations field's value.

func (DeleteKnownHostKeysOutput) String added in v1.19.0 

func (s DeleteKnownHostKeysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLoadBalancerOutput) SetOperations added in v1.12.37 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s DeleteLoadBalancerTlsCertificateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLoadBalancerTlsCertificateInput) SetCertificateName added in v1.12.37 

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

SetCertificateName sets the CertificateName field's value.

func (*DeleteLoadBalancerTlsCertificateInput) SetForce added in v1.12.37 

func (s *DeleteLoadBalancerTlsCertificateInput) SetForce(v bool) *DeleteLoadBalancerTlsCertificateInput

SetForce sets the Force field's value.

func (*DeleteLoadBalancerTlsCertificateInput) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (DeleteLoadBalancerTlsCertificateInput) String added in v1.12.37 

func (s DeleteLoadBalancerTlsCertificateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLoadBalancerTlsCertificateInput) Validate added in v1.12.37 

func (s *DeleteLoadBalancerTlsCertificateInput) Validate() error

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

type DeleteLoadBalancerTlsCertificateOutput added in v1.12.37 

type DeleteLoadBalancerTlsCertificateOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteLoadBalancerTlsCertificateOutput) GoString added in v1.12.37 

func (s DeleteLoadBalancerTlsCertificateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLoadBalancerTlsCertificateOutput) SetOperations added in v1.12.37 

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

SetOperations sets the Operations field's value.

func (DeleteLoadBalancerTlsCertificateOutput) String added in v1.12.37 

func (s DeleteLoadBalancerTlsCertificateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRelationalDatabaseInput added in v1.15.56 

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

func (s DeleteRelationalDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRelationalDatabaseInput) SetFinalRelationalDatabaseSnapshotName added in v1.15.56 

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

SetFinalRelationalDatabaseSnapshotName sets the FinalRelationalDatabaseSnapshotName field's value.

func (*DeleteRelationalDatabaseInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*DeleteRelationalDatabaseInput) SetSkipFinalSnapshot added in v1.15.56 

func (s *DeleteRelationalDatabaseInput) SetSkipFinalSnapshot(v bool) *DeleteRelationalDatabaseInput

SetSkipFinalSnapshot sets the SkipFinalSnapshot field's value.

func (DeleteRelationalDatabaseInput) String added in v1.15.56 

func (s DeleteRelationalDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRelationalDatabaseInput) Validate added in v1.15.56 

func (s *DeleteRelationalDatabaseInput) Validate() error

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

type DeleteRelationalDatabaseOutput added in v1.15.56 

type DeleteRelationalDatabaseOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteRelationalDatabaseOutput) GoString added in v1.15.56 

func (s DeleteRelationalDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRelationalDatabaseOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (DeleteRelationalDatabaseOutput) String added in v1.15.56 

func (s DeleteRelationalDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRelationalDatabaseSnapshotInput added in v1.15.56 

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

func (s DeleteRelationalDatabaseSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName added in v1.15.56 

func (s *DeleteRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName(v string) *DeleteRelationalDatabaseSnapshotInput

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (DeleteRelationalDatabaseSnapshotInput) String added in v1.15.56 

func (s DeleteRelationalDatabaseSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRelationalDatabaseSnapshotInput) Validate added in v1.15.56 

func (s *DeleteRelationalDatabaseSnapshotInput) Validate() error

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

type DeleteRelationalDatabaseSnapshotOutput added in v1.15.56 

type DeleteRelationalDatabaseSnapshotOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteRelationalDatabaseSnapshotOutput) GoString added in v1.15.56 

func (s DeleteRelationalDatabaseSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRelationalDatabaseSnapshotOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (DeleteRelationalDatabaseSnapshotOutput) String added in v1.15.56 

func (s DeleteRelationalDatabaseSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DestinationInfo added in v1.15.86 

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

func (s DestinationInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DestinationInfo) SetId added in v1.15.86 

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

SetId sets the Id field's value.

func (*DestinationInfo) SetService added in v1.15.86 

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

SetService sets the Service field's value.

func (DestinationInfo) String added in v1.15.86 

func (s DestinationInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetachCertificateFromDistributionInput added in v1.33.11 

type DetachCertificateFromDistributionInput struct {

	// The name of the distribution from which to detach the certificate.
	//
	// Use the GetDistributions action to get a list of distribution names that
	// you can specify.
	//
	// DistributionName is a required field
	DistributionName *string `locationName:"distributionName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetachCertificateFromDistributionInput) GoString added in v1.33.11 

func (s DetachCertificateFromDistributionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachCertificateFromDistributionInput) SetDistributionName added in v1.33.11 

func (s *DetachCertificateFromDistributionInput) SetDistributionName(v string) *DetachCertificateFromDistributionInput

SetDistributionName sets the DistributionName field's value.

func (DetachCertificateFromDistributionInput) String added in v1.33.11 

func (s DetachCertificateFromDistributionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachCertificateFromDistributionInput) Validate added in v1.33.11 

func (s *DetachCertificateFromDistributionInput) Validate() error

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

type DetachCertificateFromDistributionOutput added in v1.33.11 

type DetachCertificateFromDistributionOutput struct {

	// An object that describes the result of the action, such as the status of
	// the request, the timestamp of the request, and the resources affected by
	// the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (DetachCertificateFromDistributionOutput) GoString added in v1.33.11 

func (s DetachCertificateFromDistributionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachCertificateFromDistributionOutput) SetOperation added in v1.33.11 

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

SetOperation sets the Operation field's value.

func (DetachCertificateFromDistributionOutput) String added in v1.33.11 

func (s DetachCertificateFromDistributionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s DetachInstancesFromLoadBalancerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachInstancesFromLoadBalancerInput) SetInstanceNames added in v1.12.37 

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

SetInstanceNames sets the InstanceNames field's value.

func (*DetachInstancesFromLoadBalancerInput) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (DetachInstancesFromLoadBalancerInput) String added in v1.12.37 

func (s DetachInstancesFromLoadBalancerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachInstancesFromLoadBalancerInput) Validate added in v1.12.37 

func (s *DetachInstancesFromLoadBalancerInput) Validate() error

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

type DetachInstancesFromLoadBalancerOutput added in v1.12.37 

type DetachInstancesFromLoadBalancerOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DetachInstancesFromLoadBalancerOutput) GoString added in v1.12.37 

func (s DetachInstancesFromLoadBalancerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetachInstancesFromLoadBalancerOutput) SetOperations added in v1.12.37 

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

SetOperations sets the Operations field's value.

func (DetachInstancesFromLoadBalancerOutput) String added in v1.12.37 

func (s DetachInstancesFromLoadBalancerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DetachStaticIpOutput) GoString 

func (s DetachStaticIpOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableAddOnInput added in v1.25.4 

type DisableAddOnInput struct {

	// The add-on type to disable.
	//
	// AddOnType is a required field
	AddOnType *string `locationName:"addOnType" type:"string" required:"true" enum:"AddOnType"`

	// The name of the source resource for which to disable the add-on.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisableAddOnInput) GoString added in v1.25.4 

func (s DisableAddOnInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableAddOnInput) SetAddOnType added in v1.25.4 

func (s *DisableAddOnInput) SetAddOnType(v string) *DisableAddOnInput

SetAddOnType sets the AddOnType field's value.

func (*DisableAddOnInput) SetResourceName added in v1.25.4 

func (s *DisableAddOnInput) SetResourceName(v string) *DisableAddOnInput

SetResourceName sets the ResourceName field's value.

func (DisableAddOnInput) String added in v1.25.4 

func (s DisableAddOnInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableAddOnInput) Validate added in v1.25.4 

func (s *DisableAddOnInput) Validate() error

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

type DisableAddOnOutput added in v1.25.4 

type DisableAddOnOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (DisableAddOnOutput) GoString added in v1.25.4 

func (s DisableAddOnOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableAddOnOutput) SetOperations added in v1.25.4 

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

SetOperations sets the Operations field's value.

func (DisableAddOnOutput) String added in v1.25.4 

func (s DisableAddOnOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Disk 

type Disk struct {

	// An array of objects representing the add-ons enabled on the disk.
	AddOns []*AddOn `locationName:"addOns" type:"list"`

	// 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a block storage disk.

func (Disk) GoString 

func (s Disk) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Disk) SetAddOns added in v1.25.4 

func (s *Disk) SetAddOns(v []*AddOn) *Disk

SetAddOns sets the AddOns field's value.

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DiskInfo added in v1.15.86 

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

func (s DiskInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DiskInfo) SetIsSystemDisk added in v1.15.86 

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

SetIsSystemDisk sets the IsSystemDisk field's value.

func (*DiskInfo) SetName added in v1.15.86 

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

SetName sets the Name field's value.

func (*DiskInfo) SetPath added in v1.15.86 

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

SetPath sets the Path field's value.

func (*DiskInfo) SetSizeInGb added in v1.15.86 

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

SetSizeInGb sets the SizeInGb field's value.

func (DiskInfo) String added in v1.15.86 

func (s DiskInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// A Boolean value indicating whether the snapshot was created from an automatic
	// snapshot.
	IsFromAutoSnapshot *bool `locationName:"isFromAutoSnapshot" type:"boolean"`

	// 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 snapshot.
	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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

SetFromInstanceArn sets the FromInstanceArn field's value.

func (*DiskSnapshot) SetFromInstanceName added in v1.16.21 

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

SetFromInstanceName sets the FromInstanceName field's value.

func (*DiskSnapshot) SetIsFromAutoSnapshot added in v1.25.4 

func (s *DiskSnapshot) SetIsFromAutoSnapshot(v bool) *DiskSnapshot

SetIsFromAutoSnapshot sets the IsFromAutoSnapshot 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.15.86 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DiskSnapshotInfo added in v1.15.86 

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

func (s DiskSnapshotInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DiskSnapshotInfo) SetSizeInGb added in v1.15.86 

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

SetSizeInGb sets the SizeInGb field's value.

func (DiskSnapshotInfo) String added in v1.15.86 

func (s DiskSnapshotInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DistributionBundle added in v1.33.11 

type DistributionBundle struct {

	// The ID of the bundle.
	BundleId *string `locationName:"bundleId" type:"string"`

	// Indicates whether the bundle is active, and can be specified for a new or
	// existing distribution.
	IsActive *bool `locationName:"isActive" type:"boolean"`

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

	// The monthly price, in US dollars, of the bundle.
	Price *float64 `locationName:"price" type:"float"`

	// The monthly network transfer quota of the bundle.
	TransferPerMonthInGb *int64 `locationName:"transferPerMonthInGb" type:"integer"`
	// contains filtered or unexported fields
}

Describes the specifications of a distribution bundle.

func (DistributionBundle) GoString added in v1.33.11 

func (s DistributionBundle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DistributionBundle) SetBundleId added in v1.33.11 

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

SetBundleId sets the BundleId field's value.

func (*DistributionBundle) SetIsActive added in v1.33.11 

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

SetIsActive sets the IsActive field's value.

func (*DistributionBundle) SetName added in v1.33.11 

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

SetName sets the Name field's value.

func (*DistributionBundle) SetPrice added in v1.33.11 

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

SetPrice sets the Price field's value.

func (*DistributionBundle) SetTransferPerMonthInGb added in v1.33.11 

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

SetTransferPerMonthInGb sets the TransferPerMonthInGb field's value.

func (DistributionBundle) String added in v1.33.11 

func (s DistributionBundle) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DnsRecordCreationState added in v1.44.133 

type DnsRecordCreationState struct {

	// The status code for the automated DNS record creation.
	//
	// Following are the possible values:
	//
	//    * SUCCEEDED - The validation records were successfully added to the domain.
	//
	//    * STARTED - The automatic DNS record creation has started.
	//
	//    * FAILED - The validation records failed to be added to the domain.
	Code *string `locationName:"code" type:"string" enum:"DnsRecordCreationStateCode"`

	// The message that describes the reason for the status code.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate.

When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see Verify an SSL/TLS certificate in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/verify-tls-ssl-certificate-using-dns-cname-https) in the Amazon Lightsail Developer Guide.

func (DnsRecordCreationState) GoString added in v1.44.133 

func (s DnsRecordCreationState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DnsRecordCreationState) SetCode added in v1.44.133 

func (s *DnsRecordCreationState) SetCode(v string) *DnsRecordCreationState

SetCode sets the Code field's value.

func (*DnsRecordCreationState) SetMessage added in v1.44.133 

func (s *DnsRecordCreationState) SetMessage(v string) *DnsRecordCreationState

SetMessage sets the Message field's value.

func (DnsRecordCreationState) String added in v1.44.133 

func (s DnsRecordCreationState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// An object that describes the state of the Route 53 domain delegation to a
	// Lightsail DNS zone.
	RegisteredDomainDelegationInfo *RegisteredDomainDelegationInfo `locationName:"registeredDomainDelegationInfo" type:"structure"`

	// 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a domain where you are storing recordsets.

func (Domain) GoString 

func (s Domain) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetRegisteredDomainDelegationInfo added in v1.44.133 

func (s *Domain) SetRegisteredDomainDelegationInfo(v *RegisteredDomainDelegationInfo) *Domain

SetRegisteredDomainDelegationInfo sets the RegisteredDomainDelegationInfo 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.15.86 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 IP address (e.g., 192.0.2.0), or AWS name server (e.g., ns-111.awsdns-22.com.).
	//
	// For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com.
	// For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.
	// For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com.
	// Be sure to also set isAlias to true when setting up an A record for a Lightsail
	// load balancer, distribution, or container service.
	Target *string `locationName:"target" type:"string"`

	// The type of domain entry, such as address for IPv4 (A), address for IPv6
	// (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start
	// of authority (SOA), service locator (SRV), or text (TXT).
	//
	// The following domain entry types can be used:
	//
	//    * A
	//
	//    * AAAA
	//
	//    * CNAME
	//
	//    * MX
	//
	//    * NS
	//
	//    * SOA
	//
	//    * SRV
	//
	//    * TXT
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainValidationRecord added in v1.33.11 

type DomainValidationRecord struct {

	// An object that describes the state of the canonical name (CNAME) records
	// that are automatically added by Lightsail to the DNS of the domain to validate
	// domain ownership.
	DnsRecordCreationState *DnsRecordCreationState `locationName:"dnsRecordCreationState" type:"structure"`

	// The domain name of the certificate validation record. For example, example.com
	// or www.example.com.
	DomainName *string `locationName:"domainName" type:"string"`

	// An object that describes the DNS records to add to your domain's DNS to validate
	// it for the certificate.
	ResourceRecord *ResourceRecord `locationName:"resourceRecord" type:"structure"`

	// The validation status of the record.
	ValidationStatus *string `locationName:"validationStatus" type:"string" enum:"CertificateDomainValidationStatus"`
	// contains filtered or unexported fields
}

Describes the domain name system (DNS) records that you must add to the DNS of your registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

func (DomainValidationRecord) GoString added in v1.33.11 

func (s DomainValidationRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainValidationRecord) SetDnsRecordCreationState added in v1.44.133 

func (s *DomainValidationRecord) SetDnsRecordCreationState(v *DnsRecordCreationState) *DomainValidationRecord

SetDnsRecordCreationState sets the DnsRecordCreationState field's value.

func (*DomainValidationRecord) SetDomainName added in v1.33.11 

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

SetDomainName sets the DomainName field's value.

func (*DomainValidationRecord) SetResourceRecord added in v1.33.11 

func (s *DomainValidationRecord) SetResourceRecord(v *ResourceRecord) *DomainValidationRecord

SetResourceRecord sets the ResourceRecord field's value.

func (*DomainValidationRecord) SetValidationStatus added in v1.44.133 

func (s *DomainValidationRecord) SetValidationStatus(v string) *DomainValidationRecord

SetValidationStatus sets the ValidationStatus field's value.

func (DomainValidationRecord) String added in v1.33.11 

func (s DomainValidationRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DownloadDefaultKeyPairInput 

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

func (DownloadDefaultKeyPairInput) GoString 

func (s DownloadDefaultKeyPairInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DownloadDefaultKeyPairInput) String 

func (s DownloadDefaultKeyPairInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DownloadDefaultKeyPairOutput 

type DownloadDefaultKeyPairOutput struct {

	// The timestamp when the default key pair was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DownloadDefaultKeyPairOutput) SetCreatedAt added in v1.43.6 

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

SetCreatedAt sets the CreatedAt field's value.

func (*DownloadDefaultKeyPairOutput) SetPrivateKeyBase64 

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

SetPrivateKeyBase64 sets the PrivateKeyBase64 field's value.

func (*DownloadDefaultKeyPairOutput) SetPublicKeyBase64 

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

SetPublicKeyBase64 sets the PublicKeyBase64 field's value.

func (DownloadDefaultKeyPairOutput) String 

func (s DownloadDefaultKeyPairOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnableAddOnInput added in v1.25.4 

type EnableAddOnInput struct {

	// An array of strings representing the add-on to enable or modify.
	//
	// AddOnRequest is a required field
	AddOnRequest *AddOnRequest `locationName:"addOnRequest" type:"structure" required:"true"`

	// The name of the source resource for which to enable or modify the add-on.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (EnableAddOnInput) GoString added in v1.25.4 

func (s EnableAddOnInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableAddOnInput) SetAddOnRequest added in v1.25.4 

func (s *EnableAddOnInput) SetAddOnRequest(v *AddOnRequest) *EnableAddOnInput

SetAddOnRequest sets the AddOnRequest field's value.

func (*EnableAddOnInput) SetResourceName added in v1.25.4 

func (s *EnableAddOnInput) SetResourceName(v string) *EnableAddOnInput

SetResourceName sets the ResourceName field's value.

func (EnableAddOnInput) String added in v1.25.4 

func (s EnableAddOnInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableAddOnInput) Validate added in v1.25.4 

func (s *EnableAddOnInput) Validate() error

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

type EnableAddOnOutput added in v1.25.4 

type EnableAddOnOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (EnableAddOnOutput) GoString added in v1.25.4 

func (s EnableAddOnOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableAddOnOutput) SetOperations added in v1.25.4 

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

SetOperations sets the Operations field's value.

func (EnableAddOnOutput) String added in v1.25.4 

func (s EnableAddOnOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EndpointRequest added in v1.35.27 

type EndpointRequest struct {

	// The name of the container for the endpoint.
	//
	// ContainerName is a required field
	ContainerName *string `locationName:"containerName" type:"string" required:"true"`

	// The port of the container to which traffic is forwarded to.
	//
	// ContainerPort is a required field
	ContainerPort *int64 `locationName:"containerPort" type:"integer" required:"true"`

	// An object that describes the health check configuration of the container.
	HealthCheck *ContainerServiceHealthCheckConfig `locationName:"healthCheck" type:"structure"`
	// contains filtered or unexported fields
}

Describes the settings of a public endpoint for an Amazon Lightsail container service.

func (EndpointRequest) GoString added in v1.35.27 

func (s EndpointRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointRequest) SetContainerName added in v1.35.27 

func (s *EndpointRequest) SetContainerName(v string) *EndpointRequest

SetContainerName sets the ContainerName field's value.

func (*EndpointRequest) SetContainerPort added in v1.35.27 

func (s *EndpointRequest) SetContainerPort(v int64) *EndpointRequest

SetContainerPort sets the ContainerPort field's value.

func (*EndpointRequest) SetHealthCheck added in v1.35.27 

func (s *EndpointRequest) SetHealthCheck(v *ContainerServiceHealthCheckConfig) *EndpointRequest

SetHealthCheck sets the HealthCheck field's value.

func (EndpointRequest) String added in v1.35.27 

func (s EndpointRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EndpointRequest) Validate added in v1.35.27 

func (s *EndpointRequest) Validate() error

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

type ExportSnapshotInput added in v1.15.86 

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

func (s ExportSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportSnapshotInput) SetSourceSnapshotName added in v1.15.86 

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

SetSourceSnapshotName sets the SourceSnapshotName field's value.

func (ExportSnapshotInput) String added in v1.15.86 

func (s ExportSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportSnapshotInput) Validate added in v1.15.86 

func (s *ExportSnapshotInput) Validate() error

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

type ExportSnapshotOutput added in v1.15.86 

type ExportSnapshotOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (ExportSnapshotOutput) GoString added in v1.15.86 

func (s ExportSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportSnapshotOutput) SetOperations added in v1.15.86 

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

SetOperations sets the Operations field's value.

func (ExportSnapshotOutput) String added in v1.15.86 

func (s ExportSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportSnapshotRecord added in v1.15.86 

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

func (s ExportSnapshotRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportSnapshotRecord) SetArn added in v1.15.86 

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

SetArn sets the Arn field's value.

func (*ExportSnapshotRecord) SetCreatedAt added in v1.15.86 

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

SetCreatedAt sets the CreatedAt field's value.

func (*ExportSnapshotRecord) SetDestinationInfo added in v1.15.86 

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

SetDestinationInfo sets the DestinationInfo field's value.

func (*ExportSnapshotRecord) SetLocation added in v1.15.86 

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

SetLocation sets the Location field's value.

func (*ExportSnapshotRecord) SetName added in v1.15.86 

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

SetName sets the Name field's value.

func (*ExportSnapshotRecord) SetResourceType added in v1.15.86 

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

SetResourceType sets the ResourceType field's value.

func (*ExportSnapshotRecord) SetSourceInfo added in v1.15.86 

func (s *ExportSnapshotRecord) SetSourceInfo(v *ExportSnapshotRecordSourceInfo) *ExportSnapshotRecord

SetSourceInfo sets the SourceInfo field's value.

func (*ExportSnapshotRecord) SetState added in v1.15.86 

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

SetState sets the State field's value.

func (ExportSnapshotRecord) String added in v1.15.86 

func (s ExportSnapshotRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportSnapshotRecordSourceInfo added in v1.15.86 

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

func (s ExportSnapshotRecordSourceInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportSnapshotRecordSourceInfo) SetArn added in v1.15.86 

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

SetArn sets the Arn field's value.

func (*ExportSnapshotRecordSourceInfo) SetCreatedAt added in v1.15.86 

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

SetCreatedAt sets the CreatedAt field's value.

func (*ExportSnapshotRecordSourceInfo) SetDiskSnapshotInfo added in v1.15.86 

func (s *ExportSnapshotRecordSourceInfo) SetDiskSnapshotInfo(v *DiskSnapshotInfo) *ExportSnapshotRecordSourceInfo

SetDiskSnapshotInfo sets the DiskSnapshotInfo field's value.

func (*ExportSnapshotRecordSourceInfo) SetFromResourceArn added in v1.15.86 

func (s *ExportSnapshotRecordSourceInfo) SetFromResourceArn(v string) *ExportSnapshotRecordSourceInfo

SetFromResourceArn sets the FromResourceArn field's value.

func (*ExportSnapshotRecordSourceInfo) SetFromResourceName added in v1.15.86 

func (s *ExportSnapshotRecordSourceInfo) SetFromResourceName(v string) *ExportSnapshotRecordSourceInfo

SetFromResourceName sets the FromResourceName field's value.

func (*ExportSnapshotRecordSourceInfo) SetInstanceSnapshotInfo added in v1.15.86 

func (s *ExportSnapshotRecordSourceInfo) SetInstanceSnapshotInfo(v *InstanceSnapshotInfo) *ExportSnapshotRecordSourceInfo

SetInstanceSnapshotInfo sets the InstanceSnapshotInfo field's value.

func (*ExportSnapshotRecordSourceInfo) SetName added in v1.15.86 

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

SetName sets the Name field's value.

func (*ExportSnapshotRecordSourceInfo) SetResourceType added in v1.15.86 

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

SetResourceType sets the ResourceType field's value.

func (ExportSnapshotRecordSourceInfo) String added in v1.15.86 

func (s ExportSnapshotRecordSourceInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetActiveNamesInput 

type GetActiveNamesInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetActiveNames request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetActiveNamesInput) GoString 

func (s GetActiveNamesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetActiveNamesOutput 

type GetActiveNamesOutput struct {

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetActiveNames request and
	// specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetActiveNamesOutput) GoString 

func (s GetActiveNamesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAlarmsInput added in v1.29.12 

type GetAlarmsInput struct {

	// The name of the alarm.
	//
	// Specify an alarm name to return information about a specific alarm.
	AlarmName *string `locationName:"alarmName" type:"string"`

	// The name of the Lightsail resource being monitored by the alarm.
	//
	// Specify a monitored resource name to return information about all alarms
	// for a specific resource.
	MonitoredResourceName *string `locationName:"monitoredResourceName" type:"string"`

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetAlarms request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetAlarmsInput) GoString added in v1.29.12 

func (s GetAlarmsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAlarmsInput) SetAlarmName added in v1.29.12 

func (s *GetAlarmsInput) SetAlarmName(v string) *GetAlarmsInput

SetAlarmName sets the AlarmName field's value.

func (*GetAlarmsInput) SetMonitoredResourceName added in v1.29.12 

func (s *GetAlarmsInput) SetMonitoredResourceName(v string) *GetAlarmsInput

SetMonitoredResourceName sets the MonitoredResourceName field's value.

func (*GetAlarmsInput) SetPageToken added in v1.29.12 

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

SetPageToken sets the PageToken field's value.

func (GetAlarmsInput) String added in v1.29.12 

func (s GetAlarmsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAlarmsOutput added in v1.29.12 

type GetAlarmsOutput struct {

	// An array of objects that describe the alarms.
	Alarms []*Alarm `locationName:"alarms" type:"list"`

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetAlarms request and specify
	// the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetAlarmsOutput) GoString added in v1.29.12 

func (s GetAlarmsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAlarmsOutput) SetAlarms added in v1.29.12 

func (s *GetAlarmsOutput) SetAlarms(v []*Alarm) *GetAlarmsOutput

SetAlarms sets the Alarms field's value.

func (*GetAlarmsOutput) SetNextPageToken added in v1.29.12 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetAlarmsOutput) String added in v1.29.12 

func (s GetAlarmsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAutoSnapshotsInput added in v1.25.4 

type GetAutoSnapshotsInput struct {

	// The name of the source instance or disk from which to get automatic snapshot
	// information.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAutoSnapshotsInput) GoString added in v1.25.4 

func (s GetAutoSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAutoSnapshotsInput) SetResourceName added in v1.25.4 

func (s *GetAutoSnapshotsInput) SetResourceName(v string) *GetAutoSnapshotsInput

SetResourceName sets the ResourceName field's value.

func (GetAutoSnapshotsInput) String added in v1.25.4 

func (s GetAutoSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAutoSnapshotsInput) Validate added in v1.25.4 

func (s *GetAutoSnapshotsInput) Validate() error

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

type GetAutoSnapshotsOutput added in v1.25.4 

type GetAutoSnapshotsOutput struct {

	// An array of objects that describe the automatic snapshots that are available
	// for the specified source instance or disk.
	AutoSnapshots []*AutoSnapshotDetails `locationName:"autoSnapshots" type:"list"`

	// The name of the source instance or disk for the automatic snapshots.
	ResourceName *string `locationName:"resourceName" type:"string"`

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

func (GetAutoSnapshotsOutput) GoString added in v1.25.4 

func (s GetAutoSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAutoSnapshotsOutput) SetAutoSnapshots added in v1.25.4 

func (s *GetAutoSnapshotsOutput) SetAutoSnapshots(v []*AutoSnapshotDetails) *GetAutoSnapshotsOutput

SetAutoSnapshots sets the AutoSnapshots field's value.

func (*GetAutoSnapshotsOutput) SetResourceName added in v1.25.4 

func (s *GetAutoSnapshotsOutput) SetResourceName(v string) *GetAutoSnapshotsOutput

SetResourceName sets the ResourceName field's value.

func (*GetAutoSnapshotsOutput) SetResourceType added in v1.25.4 

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

SetResourceType sets the ResourceType field's value.

func (GetAutoSnapshotsOutput) String added in v1.25.4 

func (s GetAutoSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBlueprintsInput 

type GetBlueprintsInput struct {

	// A Boolean value that indicates whether to include inactive (unavailable)
	// blueprints in the response of your request.
	IncludeInactive *bool `locationName:"includeInactive" type:"boolean"`

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetBlueprints request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBlueprintsInput) GoString 

func (s GetBlueprintsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBlueprintsOutput 

type GetBlueprintsOutput struct {

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetBlueprints request and
	// specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBlueprintsOutput) GoString 

func (s GetBlueprintsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBucketAccessKeysInput added in v1.40.0 

type GetBucketAccessKeysInput struct {

	// The name of the bucket for which to return access keys.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBucketAccessKeysInput) GoString added in v1.40.0 

func (s GetBucketAccessKeysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketAccessKeysInput) SetBucketName added in v1.40.0 

func (s *GetBucketAccessKeysInput) SetBucketName(v string) *GetBucketAccessKeysInput

SetBucketName sets the BucketName field's value.

func (GetBucketAccessKeysInput) String added in v1.40.0 

func (s GetBucketAccessKeysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketAccessKeysInput) Validate added in v1.40.0 

func (s *GetBucketAccessKeysInput) Validate() error

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

type GetBucketAccessKeysOutput added in v1.40.0 

type GetBucketAccessKeysOutput struct {

	// An object that describes the access keys for the specified bucket.
	AccessKeys []*AccessKey `locationName:"accessKeys" type:"list"`
	// contains filtered or unexported fields
}

func (GetBucketAccessKeysOutput) GoString added in v1.40.0 

func (s GetBucketAccessKeysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketAccessKeysOutput) SetAccessKeys added in v1.40.0 

func (s *GetBucketAccessKeysOutput) SetAccessKeys(v []*AccessKey) *GetBucketAccessKeysOutput

SetAccessKeys sets the AccessKeys field's value.

func (GetBucketAccessKeysOutput) String added in v1.40.0 

func (s GetBucketAccessKeysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBucketBundlesInput added in v1.40.0 

type GetBucketBundlesInput struct {

	// A Boolean value that indicates whether to include inactive (unavailable)
	// bundles in the response of your request.
	IncludeInactive *bool `locationName:"includeInactive" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetBucketBundlesInput) GoString added in v1.40.0 

func (s GetBucketBundlesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketBundlesInput) SetIncludeInactive added in v1.40.0 

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

SetIncludeInactive sets the IncludeInactive field's value.

func (GetBucketBundlesInput) String added in v1.40.0 

func (s GetBucketBundlesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBucketBundlesOutput added in v1.40.0 

type GetBucketBundlesOutput struct {

	// An object that describes bucket bundles.
	Bundles []*BucketBundle `locationName:"bundles" type:"list"`
	// contains filtered or unexported fields
}

func (GetBucketBundlesOutput) GoString added in v1.40.0 

func (s GetBucketBundlesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketBundlesOutput) SetBundles added in v1.40.0 

func (s *GetBucketBundlesOutput) SetBundles(v []*BucketBundle) *GetBucketBundlesOutput

SetBundles sets the Bundles field's value.

func (GetBucketBundlesOutput) String added in v1.40.0 

func (s GetBucketBundlesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBucketMetricDataInput added in v1.40.0 

type GetBucketMetricDataInput struct {

	// The name of the bucket for which to get metric data.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`

	// The timestamp indicating the latest data to be returned.
	//
	// EndTime is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The metric for which you want to return information.
	//
	// Valid bucket metric names are listed below, along with the most useful statistics
	// to include in your request, and the published unit value.
	//
	// These bucket metrics are reported once per day.
	//
	//    * BucketSizeBytes - The amount of data in bytes stored in a bucket. This
	//    value is calculated by summing the size of all objects in the bucket (including
	//    object versions), including the size of all parts for all incomplete multipart
	//    uploads to the bucket. Statistics: The most useful statistic is Maximum.
	//    Unit: The published unit is Bytes.
	//
	//    * NumberOfObjects - The total number of objects stored in a bucket. This
	//    value is calculated by counting all objects in the bucket (including object
	//    versions) and the total number of parts for all incomplete multipart uploads
	//    to the bucket. Statistics: The most useful statistic is Average. Unit:
	//    The published unit is Count.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"BucketMetricName"`

	// The granularity, in seconds, of the returned data points.
	//
	// Bucket storage metrics are reported once per day. Therefore, you should specify
	// a period of 86400 seconds, which is the number of seconds in a day.
	//
	// Period is a required field
	Period *int64 `locationName:"period" min:"60" type:"integer" required:"true"`

	// The timestamp indicating the earliest data to be returned.
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

	// The statistic for the metric.
	//
	// The following statistics are available:
	//
	//    * Minimum - The lowest value observed during the specified period. Use
	//    this value to determine low volumes of activity for your application.
	//
	//    * Maximum - The highest value observed during the specified period. Use
	//    this value to determine high volumes of activity for your application.
	//
	//    * Sum - The sum of all values submitted for the matching metric. You can
	//    use this statistic to determine the total volume of a metric.
	//
	//    * Average - The value of Sum / SampleCount during the specified period.
	//    By comparing this statistic with the Minimum and Maximum values, you can
	//    determine the full scope of a metric and how close the average use is
	//    to the Minimum and Maximum values. This comparison helps you to know when
	//    to increase or decrease your resources.
	//
	//    * SampleCount - The count, or number, of data points used for the statistical
	//    calculation.
	//
	// Statistics is a required field
	Statistics []*string `locationName:"statistics" type:"list" required:"true" enum:"MetricStatistic"`

	// The unit for the metric data request.
	//
	// Valid units depend on the metric data being requested. For the valid units
	// with each available metric, see the metricName parameter.
	//
	// Unit is a required field
	Unit *string `locationName:"unit" type:"string" required:"true" enum:"MetricUnit"`
	// contains filtered or unexported fields
}

func (GetBucketMetricDataInput) GoString added in v1.40.0 

func (s GetBucketMetricDataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketMetricDataInput) SetBucketName added in v1.40.0 

func (s *GetBucketMetricDataInput) SetBucketName(v string) *GetBucketMetricDataInput

SetBucketName sets the BucketName field's value.

func (*GetBucketMetricDataInput) SetEndTime added in v1.40.0 

func (s *GetBucketMetricDataInput) SetEndTime(v time.Time) *GetBucketMetricDataInput

SetEndTime sets the EndTime field's value.

func (*GetBucketMetricDataInput) SetMetricName added in v1.40.0 

func (s *GetBucketMetricDataInput) SetMetricName(v string) *GetBucketMetricDataInput

SetMetricName sets the MetricName field's value.

func (*GetBucketMetricDataInput) SetPeriod added in v1.40.0 

func (s *GetBucketMetricDataInput) SetPeriod(v int64) *GetBucketMetricDataInput

SetPeriod sets the Period field's value.

func (*GetBucketMetricDataInput) SetStartTime added in v1.40.0 

func (s *GetBucketMetricDataInput) SetStartTime(v time.Time) *GetBucketMetricDataInput

SetStartTime sets the StartTime field's value.

func (*GetBucketMetricDataInput) SetStatistics added in v1.40.0 

func (s *GetBucketMetricDataInput) SetStatistics(v []*string) *GetBucketMetricDataInput

SetStatistics sets the Statistics field's value.

func (*GetBucketMetricDataInput) SetUnit added in v1.40.0 

func (s *GetBucketMetricDataInput) SetUnit(v string) *GetBucketMetricDataInput

SetUnit sets the Unit field's value.

func (GetBucketMetricDataInput) String added in v1.40.0 

func (s GetBucketMetricDataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketMetricDataInput) Validate added in v1.40.0 

func (s *GetBucketMetricDataInput) Validate() error

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

type GetBucketMetricDataOutput added in v1.40.0 

type GetBucketMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The name of the metric returned.
	MetricName *string `locationName:"metricName" type:"string" enum:"BucketMetricName"`
	// contains filtered or unexported fields
}

func (GetBucketMetricDataOutput) GoString added in v1.40.0 

func (s GetBucketMetricDataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketMetricDataOutput) SetMetricData added in v1.40.0 

func (s *GetBucketMetricDataOutput) SetMetricData(v []*MetricDatapoint) *GetBucketMetricDataOutput

SetMetricData sets the MetricData field's value.

func (*GetBucketMetricDataOutput) SetMetricName added in v1.40.0 

func (s *GetBucketMetricDataOutput) SetMetricName(v string) *GetBucketMetricDataOutput

SetMetricName sets the MetricName field's value.

func (GetBucketMetricDataOutput) String added in v1.40.0 

func (s GetBucketMetricDataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBucketsInput added in v1.40.0 

type GetBucketsInput struct {

	// The name of the bucket for which to return information.
	//
	// When omitted, the response includes all of your buckets in the Amazon Web
	// Services Region where the request is made.
	BucketName *string `locationName:"bucketName" min:"3" type:"string"`

	// A Boolean value that indicates whether to include Lightsail instances that
	// were given access to the bucket using the SetResourceAccessForBucket (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html)
	// action.
	IncludeConnectedResources *bool `locationName:"includeConnectedResources" type:"boolean"`

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetBuckets request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBucketsInput) GoString added in v1.40.0 

func (s GetBucketsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketsInput) SetBucketName added in v1.40.0 

func (s *GetBucketsInput) SetBucketName(v string) *GetBucketsInput

SetBucketName sets the BucketName field's value.

func (*GetBucketsInput) SetIncludeConnectedResources added in v1.40.0 

func (s *GetBucketsInput) SetIncludeConnectedResources(v bool) *GetBucketsInput

SetIncludeConnectedResources sets the IncludeConnectedResources field's value.

func (*GetBucketsInput) SetPageToken added in v1.40.0 

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

SetPageToken sets the PageToken field's value.

func (GetBucketsInput) String added in v1.40.0 

func (s GetBucketsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketsInput) Validate added in v1.40.0 

func (s *GetBucketsInput) Validate() error

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

type GetBucketsOutput added in v1.40.0 

type GetBucketsOutput struct {

	// An object that describes the synchronization status of the Amazon S3 account-level
	// block public access feature for your Lightsail buckets.
	//
	// For more information about this feature and how it affects Lightsail buckets,
	// see Block public access for buckets in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets).
	AccountLevelBpaSync *AccountLevelBpaSync `locationName:"accountLevelBpaSync" type:"structure"`

	// An array of objects that describe buckets.
	Buckets []*Bucket `locationName:"buckets" type:"list"`

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetBuckets request and specify
	// the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBucketsOutput) GoString added in v1.40.0 

func (s GetBucketsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBucketsOutput) SetAccountLevelBpaSync added in v1.43.41 

func (s *GetBucketsOutput) SetAccountLevelBpaSync(v *AccountLevelBpaSync) *GetBucketsOutput

SetAccountLevelBpaSync sets the AccountLevelBpaSync field's value.

func (*GetBucketsOutput) SetBuckets added in v1.40.0 

func (s *GetBucketsOutput) SetBuckets(v []*Bucket) *GetBucketsOutput

SetBuckets sets the Buckets field's value.

func (*GetBucketsOutput) SetNextPageToken added in v1.40.0 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetBucketsOutput) String added in v1.40.0 

func (s GetBucketsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBundlesInput 

type GetBundlesInput struct {

	// A Boolean value that indicates whether to include inactive (unavailable)
	// bundles in the response of your request.
	IncludeInactive *bool `locationName:"includeInactive" type:"boolean"`

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetBundles request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBundlesInput) GoString 

func (s GetBundlesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBundlesOutput 

type GetBundlesOutput struct {

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetBundles request and specify
	// the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetBundlesOutput) GoString 

func (s GetBundlesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCertificatesInput added in v1.33.11 

type GetCertificatesInput struct {

	// The name for the certificate for which to return information.
	//
	// When omitted, the response includes all of your certificates in the Amazon
	// Web Services Region where the request is made.
	CertificateName *string `locationName:"certificateName" type:"string"`

	// The status of the certificates for which to return information.
	//
	// For example, specify ISSUED to return only certificates with an ISSUED status.
	//
	// When omitted, the response includes all of your certificates in the Amazon
	// Web Services Region where the request is made, regardless of their current
	// status.
	CertificateStatuses []*string `locationName:"certificateStatuses" type:"list" enum:"CertificateStatus"`

	// Indicates whether to include detailed information about the certificates
	// in the response.
	//
	// When omitted, the response includes only the certificate names, Amazon Resource
	// Names (ARNs), domain names, and tags.
	IncludeCertificateDetails *bool `locationName:"includeCertificateDetails" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetCertificatesInput) GoString added in v1.33.11 

func (s GetCertificatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCertificatesInput) SetCertificateName added in v1.33.11 

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

SetCertificateName sets the CertificateName field's value.

func (*GetCertificatesInput) SetCertificateStatuses added in v1.33.11 

func (s *GetCertificatesInput) SetCertificateStatuses(v []*string) *GetCertificatesInput

SetCertificateStatuses sets the CertificateStatuses field's value.

func (*GetCertificatesInput) SetIncludeCertificateDetails added in v1.33.11 

func (s *GetCertificatesInput) SetIncludeCertificateDetails(v bool) *GetCertificatesInput

SetIncludeCertificateDetails sets the IncludeCertificateDetails field's value.

func (GetCertificatesInput) String added in v1.33.11 

func (s GetCertificatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCertificatesOutput added in v1.33.11 

type GetCertificatesOutput struct {

	// An object that describes certificates.
	Certificates []*CertificateSummary `locationName:"certificates" type:"list"`
	// contains filtered or unexported fields
}

func (GetCertificatesOutput) GoString added in v1.33.11 

func (s GetCertificatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCertificatesOutput) SetCertificates added in v1.33.11 

func (s *GetCertificatesOutput) SetCertificates(v []*CertificateSummary) *GetCertificatesOutput

SetCertificates sets the Certificates field's value.

func (GetCertificatesOutput) String added in v1.33.11 

func (s GetCertificatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCloudFormationStackRecordsInput added in v1.15.86 

type GetCloudFormationStackRecordsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetClouFormationStackRecords request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetCloudFormationStackRecordsInput) GoString added in v1.15.86 

func (s GetCloudFormationStackRecordsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCloudFormationStackRecordsInput) SetPageToken added in v1.15.86 

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

SetPageToken sets the PageToken field's value.

func (GetCloudFormationStackRecordsInput) String added in v1.15.86 

func (s GetCloudFormationStackRecordsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetCloudFormationStackRecordsOutput added in v1.15.86 

type GetCloudFormationStackRecordsOutput struct {

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetCloudFormationStackRecords
	// request and specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetCloudFormationStackRecordsOutput) GoString added in v1.15.86 

func (s GetCloudFormationStackRecordsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetCloudFormationStackRecordsOutput) SetCloudFormationStackRecords added in v1.15.86 

func (s *GetCloudFormationStackRecordsOutput) SetCloudFormationStackRecords(v []*CloudFormationStackRecord) *GetCloudFormationStackRecordsOutput

SetCloudFormationStackRecords sets the CloudFormationStackRecords field's value.

func (*GetCloudFormationStackRecordsOutput) SetNextPageToken added in v1.15.86 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetCloudFormationStackRecordsOutput) String added in v1.15.86 

func (s GetCloudFormationStackRecordsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContactMethodsInput added in v1.29.12 

type GetContactMethodsInput struct {

	// The protocols used to send notifications, such as Email, or SMS (text messaging).
	//
	// Specify a protocol in your request to return information about a specific
	// contact method protocol.
	Protocols []*string `locationName:"protocols" type:"list" enum:"ContactProtocol"`
	// contains filtered or unexported fields
}

func (GetContactMethodsInput) GoString added in v1.29.12 

func (s GetContactMethodsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactMethodsInput) SetProtocols added in v1.29.12 

func (s *GetContactMethodsInput) SetProtocols(v []*string) *GetContactMethodsInput

SetProtocols sets the Protocols field's value.

func (GetContactMethodsInput) String added in v1.29.12 

func (s GetContactMethodsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContactMethodsOutput added in v1.29.12 

type GetContactMethodsOutput struct {

	// An array of objects that describe the contact methods.
	ContactMethods []*ContactMethod `locationName:"contactMethods" type:"list"`
	// contains filtered or unexported fields
}

func (GetContactMethodsOutput) GoString added in v1.29.12 

func (s GetContactMethodsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContactMethodsOutput) SetContactMethods added in v1.29.12 

func (s *GetContactMethodsOutput) SetContactMethods(v []*ContactMethod) *GetContactMethodsOutput

SetContactMethods sets the ContactMethods field's value.

func (GetContactMethodsOutput) String added in v1.29.12 

func (s GetContactMethodsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerAPIMetadataInput added in v1.35.27 

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

func (GetContainerAPIMetadataInput) GoString added in v1.35.27 

func (s GetContainerAPIMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetContainerAPIMetadataInput) String added in v1.35.27 

func (s GetContainerAPIMetadataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerAPIMetadataOutput added in v1.35.27 

type GetContainerAPIMetadataOutput struct {

	// Metadata about Lightsail containers, such as the current version of the Lightsail
	// Control (lightsailctl) plugin.
	Metadata []map[string]*string `locationName:"metadata" type:"list"`
	// contains filtered or unexported fields
}

func (GetContainerAPIMetadataOutput) GoString added in v1.35.27 

func (s GetContainerAPIMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerAPIMetadataOutput) SetMetadata added in v1.35.27 

func (s *GetContainerAPIMetadataOutput) SetMetadata(v []map[string]*string) *GetContainerAPIMetadataOutput

SetMetadata sets the Metadata field's value.

func (GetContainerAPIMetadataOutput) String added in v1.35.27 

func (s GetContainerAPIMetadataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerImagesInput added in v1.35.27 

type GetContainerImagesInput struct {

	// The name of the container service for which to return registered container
	// images.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetContainerImagesInput) GoString added in v1.35.27 

func (s GetContainerImagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerImagesInput) SetServiceName added in v1.35.27 

func (s *GetContainerImagesInput) SetServiceName(v string) *GetContainerImagesInput

SetServiceName sets the ServiceName field's value.

func (GetContainerImagesInput) String added in v1.35.27 

func (s GetContainerImagesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerImagesInput) Validate added in v1.35.27 

func (s *GetContainerImagesInput) Validate() error

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

type GetContainerImagesOutput added in v1.35.27 

type GetContainerImagesOutput struct {

	// An array of objects that describe container images that are registered to
	// the container service.
	ContainerImages []*ContainerImage `locationName:"containerImages" type:"list"`
	// contains filtered or unexported fields
}

func (GetContainerImagesOutput) GoString added in v1.35.27 

func (s GetContainerImagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerImagesOutput) SetContainerImages added in v1.35.27 

func (s *GetContainerImagesOutput) SetContainerImages(v []*ContainerImage) *GetContainerImagesOutput

SetContainerImages sets the ContainerImages field's value.

func (GetContainerImagesOutput) String added in v1.35.27 

func (s GetContainerImagesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerLogInput added in v1.35.27 

type GetContainerLogInput struct {

	// The name of the container that is either running or previously ran on the
	// container service for which to return a log.
	//
	// ContainerName is a required field
	ContainerName *string `locationName:"containerName" type:"string" required:"true"`

	// The end of the time interval for which to get log data.
	//
	// Constraints:
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use an
	//    end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end
	//    time.
	//
	// You can convert a human-friendly time to Unix time format using a converter
	// like Epoch converter (https://www.epochconverter.com/).
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// The pattern to use to filter the returned log events to a specific term.
	//
	// The following are a few examples of filter patterns that you can specify:
	//
	//    * To return all log events, specify a filter pattern of "".
	//
	//    * To exclude log events that contain the ERROR term, and return all other
	//    log events, specify a filter pattern of "-ERROR".
	//
	//    * To return log events that contain the ERROR term, specify a filter pattern
	//    of "ERROR".
	//
	//    * To return log events that contain both the ERROR and Exception terms,
	//    specify a filter pattern of "ERROR Exception".
	//
	//    * To return log events that contain the ERROR or the Exception term, specify
	//    a filter pattern of "?ERROR ?Exception".
	FilterPattern *string `locationName:"filterPattern" type:"string"`

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

	// The name of the container service for which to get a container log.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`

	// The start of the time interval for which to get log data.
	//
	// Constraints:
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use a
	//    start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the
	//    start time.
	//
	// You can convert a human-friendly time to Unix time format using a converter
	// like Epoch converter (https://www.epochconverter.com/).
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetContainerLogInput) GoString added in v1.35.27 

func (s GetContainerLogInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerLogInput) SetContainerName added in v1.35.27 

func (s *GetContainerLogInput) SetContainerName(v string) *GetContainerLogInput

SetContainerName sets the ContainerName field's value.

func (*GetContainerLogInput) SetEndTime added in v1.35.27 

func (s *GetContainerLogInput) SetEndTime(v time.Time) *GetContainerLogInput

SetEndTime sets the EndTime field's value.

func (*GetContainerLogInput) SetFilterPattern added in v1.35.27 

func (s *GetContainerLogInput) SetFilterPattern(v string) *GetContainerLogInput

SetFilterPattern sets the FilterPattern field's value.

func (*GetContainerLogInput) SetPageToken added in v1.35.27 

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

SetPageToken sets the PageToken field's value.

func (*GetContainerLogInput) SetServiceName added in v1.35.27 

func (s *GetContainerLogInput) SetServiceName(v string) *GetContainerLogInput

SetServiceName sets the ServiceName field's value.

func (*GetContainerLogInput) SetStartTime added in v1.35.27 

func (s *GetContainerLogInput) SetStartTime(v time.Time) *GetContainerLogInput

SetStartTime sets the StartTime field's value.

func (GetContainerLogInput) String added in v1.35.27 

func (s GetContainerLogInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerLogInput) Validate added in v1.35.27 

func (s *GetContainerLogInput) Validate() error

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

type GetContainerLogOutput added in v1.35.27 

type GetContainerLogOutput struct {

	// An array of objects that describe the log events of a container.
	LogEvents []*ContainerServiceLogEvent `locationName:"logEvents" type:"list"`

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetContainerLog request
	// and specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetContainerLogOutput) GoString added in v1.35.27 

func (s GetContainerLogOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerLogOutput) SetLogEvents added in v1.35.27 

func (s *GetContainerLogOutput) SetLogEvents(v []*ContainerServiceLogEvent) *GetContainerLogOutput

SetLogEvents sets the LogEvents field's value.

func (*GetContainerLogOutput) SetNextPageToken added in v1.35.27 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetContainerLogOutput) String added in v1.35.27 

func (s GetContainerLogOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerServiceDeploymentsInput added in v1.35.27 

type GetContainerServiceDeploymentsInput struct {

	// The name of the container service for which to return deployments.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetContainerServiceDeploymentsInput) GoString added in v1.35.27 

func (s GetContainerServiceDeploymentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServiceDeploymentsInput) SetServiceName added in v1.35.27 

func (s *GetContainerServiceDeploymentsInput) SetServiceName(v string) *GetContainerServiceDeploymentsInput

SetServiceName sets the ServiceName field's value.

func (GetContainerServiceDeploymentsInput) String added in v1.35.27 

func (s GetContainerServiceDeploymentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServiceDeploymentsInput) Validate added in v1.35.27 

func (s *GetContainerServiceDeploymentsInput) Validate() error

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

type GetContainerServiceDeploymentsOutput added in v1.35.27 

type GetContainerServiceDeploymentsOutput struct {

	// An array of objects that describe deployments for a container service.
	Deployments []*ContainerServiceDeployment `locationName:"deployments" type:"list"`
	// contains filtered or unexported fields
}

func (GetContainerServiceDeploymentsOutput) GoString added in v1.35.27 

func (s GetContainerServiceDeploymentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServiceDeploymentsOutput) SetDeployments added in v1.35.27 

func (s *GetContainerServiceDeploymentsOutput) SetDeployments(v []*ContainerServiceDeployment) *GetContainerServiceDeploymentsOutput

SetDeployments sets the Deployments field's value.

func (GetContainerServiceDeploymentsOutput) String added in v1.35.27 

func (s GetContainerServiceDeploymentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerServiceMetricDataInput added in v1.35.27 

type GetContainerServiceMetricDataInput struct {

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

	// The metric for which you want to return information.
	//
	// Valid container service metric names are listed below, along with the most
	// useful statistics to include in your request, and the published unit value.
	//
	//    * CPUUtilization - The average percentage of compute units that are currently
	//    in use across all nodes of the container service. This metric identifies
	//    the processing power required to run containers on each node of the container
	//    service. Statistics: The most useful statistics are Maximum and Average.
	//    Unit: The published unit is Percent.
	//
	//    * MemoryUtilization - The average percentage of available memory that
	//    is currently in use across all nodes of the container service. This metric
	//    identifies the memory required to run containers on each node of the container
	//    service. Statistics: The most useful statistics are Maximum and Average.
	//    Unit: The published unit is Percent.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"ContainerServiceMetricName"`

	// The granularity, in seconds, of the returned data points.
	//
	// All container service metric data is available in 5-minute (300 seconds)
	// granularity.
	//
	// Period is a required field
	Period *int64 `locationName:"period" min:"60" type:"integer" required:"true"`

	// The name of the container service for which to get metric data.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`

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

	// The statistic for the metric.
	//
	// The following statistics are available:
	//
	//    * Minimum - The lowest value observed during the specified period. Use
	//    this value to determine low volumes of activity for your application.
	//
	//    * Maximum - The highest value observed during the specified period. Use
	//    this value to determine high volumes of activity for your application.
	//
	//    * Sum - All values submitted for the matching metric added together. You
	//    can use this statistic to determine the total volume of a metric.
	//
	//    * Average - The value of Sum / SampleCount during the specified period.
	//    By comparing this statistic with the Minimum and Maximum values, you can
	//    determine the full scope of a metric and how close the average use is
	//    to the Minimum and Maximum values. This comparison helps you to know when
	//    to increase or decrease your resources.
	//
	//    * SampleCount - The count, or number, of data points used for the statistical
	//    calculation.
	//
	// Statistics is a required field
	Statistics []*string `locationName:"statistics" type:"list" required:"true" enum:"MetricStatistic"`
	// contains filtered or unexported fields
}

func (GetContainerServiceMetricDataInput) GoString added in v1.35.27 

func (s GetContainerServiceMetricDataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServiceMetricDataInput) SetEndTime added in v1.35.27 

func (s *GetContainerServiceMetricDataInput) SetEndTime(v time.Time) *GetContainerServiceMetricDataInput

SetEndTime sets the EndTime field's value.

func (*GetContainerServiceMetricDataInput) SetMetricName added in v1.35.27 

func (s *GetContainerServiceMetricDataInput) SetMetricName(v string) *GetContainerServiceMetricDataInput

SetMetricName sets the MetricName field's value.

func (*GetContainerServiceMetricDataInput) SetPeriod added in v1.35.27 

func (s *GetContainerServiceMetricDataInput) SetPeriod(v int64) *GetContainerServiceMetricDataInput

SetPeriod sets the Period field's value.

func (*GetContainerServiceMetricDataInput) SetServiceName added in v1.35.27 

func (s *GetContainerServiceMetricDataInput) SetServiceName(v string) *GetContainerServiceMetricDataInput

SetServiceName sets the ServiceName field's value.

func (*GetContainerServiceMetricDataInput) SetStartTime added in v1.35.27 

func (s *GetContainerServiceMetricDataInput) SetStartTime(v time.Time) *GetContainerServiceMetricDataInput

SetStartTime sets the StartTime field's value.

func (*GetContainerServiceMetricDataInput) SetStatistics added in v1.35.27 

func (s *GetContainerServiceMetricDataInput) SetStatistics(v []*string) *GetContainerServiceMetricDataInput

SetStatistics sets the Statistics field's value.

func (GetContainerServiceMetricDataInput) String added in v1.35.27 

func (s GetContainerServiceMetricDataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServiceMetricDataInput) Validate added in v1.35.27 

func (s *GetContainerServiceMetricDataInput) Validate() error

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

type GetContainerServiceMetricDataOutput added in v1.35.27 

type GetContainerServiceMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The name of the metric returned.
	MetricName *string `locationName:"metricName" type:"string" enum:"ContainerServiceMetricName"`
	// contains filtered or unexported fields
}

func (GetContainerServiceMetricDataOutput) GoString added in v1.35.27 

func (s GetContainerServiceMetricDataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServiceMetricDataOutput) SetMetricData added in v1.35.27 

func (s *GetContainerServiceMetricDataOutput) SetMetricData(v []*MetricDatapoint) *GetContainerServiceMetricDataOutput

SetMetricData sets the MetricData field's value.

func (*GetContainerServiceMetricDataOutput) SetMetricName added in v1.35.27 

func (s *GetContainerServiceMetricDataOutput) SetMetricName(v string) *GetContainerServiceMetricDataOutput

SetMetricName sets the MetricName field's value.

func (GetContainerServiceMetricDataOutput) String added in v1.35.27 

func (s GetContainerServiceMetricDataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerServicePowersInput added in v1.35.27 

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

func (GetContainerServicePowersInput) GoString added in v1.35.27 

func (s GetContainerServicePowersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetContainerServicePowersInput) String added in v1.35.27 

func (s GetContainerServicePowersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerServicePowersOutput added in v1.35.27 

type GetContainerServicePowersOutput struct {

	// An array of objects that describe the powers that can be specified for a
	// container service.
	Powers []*ContainerServicePower `locationName:"powers" type:"list"`
	// contains filtered or unexported fields
}

func (GetContainerServicePowersOutput) GoString added in v1.35.27 

func (s GetContainerServicePowersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServicePowersOutput) SetPowers added in v1.35.27 

func (s *GetContainerServicePowersOutput) SetPowers(v []*ContainerServicePower) *GetContainerServicePowersOutput

SetPowers sets the Powers field's value.

func (GetContainerServicePowersOutput) String added in v1.35.27 

func (s GetContainerServicePowersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetContainerServicesInput added in v1.35.27 

type GetContainerServicesInput struct {

	// The name of the container service for which to return information.
	//
	// When omitted, the response includes all of your container services in the
	// Amazon Web Services Region where the request is made.
	ServiceName *string `locationName:"serviceName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetContainerServicesInput) GoString added in v1.35.27 

func (s GetContainerServicesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServicesInput) SetServiceName added in v1.35.27 

func (s *GetContainerServicesInput) SetServiceName(v string) *GetContainerServicesInput

SetServiceName sets the ServiceName field's value.

func (GetContainerServicesInput) String added in v1.35.27 

func (s GetContainerServicesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServicesInput) Validate added in v1.35.27 

func (s *GetContainerServicesInput) Validate() error

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

type GetContainerServicesOutput added in v1.35.27 

type GetContainerServicesOutput struct {

	// An array of objects that describe one or more container services.
	ContainerServices []*ContainerService `locationName:"containerServices" type:"list"`
	// contains filtered or unexported fields
}

func (GetContainerServicesOutput) GoString added in v1.35.27 

func (s GetContainerServicesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetContainerServicesOutput) SetContainerServices added in v1.35.27 

func (s *GetContainerServicesOutput) SetContainerServices(v []*ContainerService) *GetContainerServicesOutput

SetContainerServices sets the ContainerServices field's value.

func (GetContainerServicesOutput) String added in v1.35.27 

func (s GetContainerServicesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDiskSnapshotOutput) SetDiskSnapshot added in v1.12.27 

func (s *GetDiskSnapshotOutput) SetDiskSnapshot(v *DiskSnapshot) *GetDiskSnapshotOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDiskSnapshotsInput added in v1.12.27 

type GetDiskSnapshotsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetDiskSnapshots request. If your
	// results are paginated, the response will return a next page token that you
	// can specify as the page token in a subsequent request.
	PageToken *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDiskSnapshotsInput) SetPageToken added in v1.12.27 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetDiskSnapshots request
	// and specify the next page token using the pageToken parameter.
	NextPageToken *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDisksInput added in v1.12.27 

type GetDisksInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetDisks request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetDisks request and specify
	// the next page token using the pageToken parameter.
	NextPageToken *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDistributionBundlesInput added in v1.33.11 

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

func (GetDistributionBundlesInput) GoString added in v1.33.11 

func (s GetDistributionBundlesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetDistributionBundlesInput) String added in v1.33.11 

func (s GetDistributionBundlesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDistributionBundlesOutput added in v1.33.11 

type GetDistributionBundlesOutput struct {

	// An object that describes a distribution bundle.
	Bundles []*DistributionBundle `locationName:"bundles" type:"list"`
	// contains filtered or unexported fields
}

func (GetDistributionBundlesOutput) GoString added in v1.33.11 

func (s GetDistributionBundlesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDistributionBundlesOutput) SetBundles added in v1.33.11 

func (s *GetDistributionBundlesOutput) SetBundles(v []*DistributionBundle) *GetDistributionBundlesOutput

SetBundles sets the Bundles field's value.

func (GetDistributionBundlesOutput) String added in v1.33.11 

func (s GetDistributionBundlesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDistributionLatestCacheResetInput added in v1.33.11 

type GetDistributionLatestCacheResetInput struct {

	// The name of the distribution for which to return the timestamp of the last
	// cache reset.
	//
	// Use the GetDistributions action to get a list of distribution names that
	// you can specify.
	//
	// When omitted, the response includes the latest cache reset timestamp of all
	// your distributions.
	DistributionName *string `locationName:"distributionName" type:"string"`
	// contains filtered or unexported fields
}

func (GetDistributionLatestCacheResetInput) GoString added in v1.33.11 

func (s GetDistributionLatestCacheResetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDistributionLatestCacheResetInput) SetDistributionName added in v1.33.11 

func (s *GetDistributionLatestCacheResetInput) SetDistributionName(v string) *GetDistributionLatestCacheResetInput

SetDistributionName sets the DistributionName field's value.

func (GetDistributionLatestCacheResetInput) String added in v1.33.11 

func (s GetDistributionLatestCacheResetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDistributionLatestCacheResetOutput added in v1.33.11 

type GetDistributionLatestCacheResetOutput struct {

	// The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time
	// format.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp"`

	// The status of the last cache reset.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

func (GetDistributionLatestCacheResetOutput) GoString added in v1.33.11 

func (s GetDistributionLatestCacheResetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDistributionLatestCacheResetOutput) SetCreateTime added in v1.33.11 

func (s *GetDistributionLatestCacheResetOutput) SetCreateTime(v time.Time) *GetDistributionLatestCacheResetOutput

SetCreateTime sets the CreateTime field's value.

func (*GetDistributionLatestCacheResetOutput) SetStatus added in v1.33.11 

func (s *GetDistributionLatestCacheResetOutput) SetStatus(v string) *GetDistributionLatestCacheResetOutput

SetStatus sets the Status field's value.

func (GetDistributionLatestCacheResetOutput) String added in v1.33.11 

func (s GetDistributionLatestCacheResetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDistributionMetricDataInput added in v1.33.11 

type GetDistributionMetricDataInput struct {

	// The name of the distribution for which to get metric data.
	//
	// Use the GetDistributions action to get a list of distribution names that
	// you can specify.
	//
	// DistributionName is a required field
	DistributionName *string `locationName:"distributionName" type:"string" required:"true"`

	// The end of the time interval for which to get metric data.
	//
	// Constraints:
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use an
	//    end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end
	//    time.
	//
	// You can convert a human-friendly time to Unix time format using a converter
	// like Epoch converter (https://www.epochconverter.com/).
	//
	// EndTime is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The metric for which you want to return information.
	//
	// Valid distribution metric names are listed below, along with the most useful
	// statistics to include in your request, and the published unit value.
	//
	//    * Requests - The total number of viewer requests received by your Lightsail
	//    distribution, for all HTTP methods, and for both HTTP and HTTPS requests.
	//    Statistics: The most useful statistic is Sum. Unit: The published unit
	//    is None.
	//
	//    * BytesDownloaded - The number of bytes downloaded by viewers for GET,
	//    HEAD, and OPTIONS requests. Statistics: The most useful statistic is Sum.
	//    Unit: The published unit is None.
	//
	//    * BytesUploaded - The number of bytes uploaded to your origin by your
	//    Lightsail distribution, using POST and PUT requests. Statistics: The most
	//    useful statistic is Sum. Unit: The published unit is None.
	//
	//    * TotalErrorRate - The percentage of all viewer requests for which the
	//    response's HTTP status code was 4xx or 5xx. Statistics: The most useful
	//    statistic is Average. Unit: The published unit is Percent.
	//
	//    * 4xxErrorRate - The percentage of all viewer requests for which the response's
	//    HTTP status cod was 4xx. In these cases, the client or client viewer may
	//    have made an error. For example, a status code of 404 (Not Found) means
	//    that the client requested an object that could not be found. Statistics:
	//    The most useful statistic is Average. Unit: The published unit is Percent.
	//
	//    * 5xxErrorRate - The percentage of all viewer requests for which the response's
	//    HTTP status code was 5xx. In these cases, the origin server did not satisfy
	//    the requests. For example, a status code of 503 (Service Unavailable)
	//    means that the origin server is currently unavailable. Statistics: The
	//    most useful statistic is Average. Unit: The published unit is Percent.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"DistributionMetricName"`

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

	// The start of the time interval for which to get metric data.
	//
	// Constraints:
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use a
	//    start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the
	//    start time.
	//
	// You can convert a human-friendly time to Unix time format using a converter
	// like Epoch converter (https://www.epochconverter.com/).
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

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

	// The unit for the metric data request.
	//
	// Valid units depend on the metric data being requested. For the valid units
	// with each available metric, see the metricName parameter.
	//
	// Unit is a required field
	Unit *string `locationName:"unit" type:"string" required:"true" enum:"MetricUnit"`
	// contains filtered or unexported fields
}

func (GetDistributionMetricDataInput) GoString added in v1.33.11 

func (s GetDistributionMetricDataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDistributionMetricDataInput) SetDistributionName added in v1.33.11 

func (s *GetDistributionMetricDataInput) SetDistributionName(v string) *GetDistributionMetricDataInput

SetDistributionName sets the DistributionName field's value.

func (*GetDistributionMetricDataInput) SetEndTime added in v1.33.11 

func (s *GetDistributionMetricDataInput) SetEndTime(v time.Time) *GetDistributionMetricDataInput

SetEndTime sets the EndTime field's value.

func (*GetDistributionMetricDataInput) SetMetricName added in v1.33.11 

func (s *GetDistributionMetricDataInput) SetMetricName(v string) *GetDistributionMetricDataInput

SetMetricName sets the MetricName field's value.

func (*GetDistributionMetricDataInput) SetPeriod added in v1.33.11 

func (s *GetDistributionMetricDataInput) SetPeriod(v int64) *GetDistributionMetricDataInput

SetPeriod sets the Period field's value.

func (*GetDistributionMetricDataInput) SetStartTime added in v1.33.11 

func (s *GetDistributionMetricDataInput) SetStartTime(v time.Time) *GetDistributionMetricDataInput

SetStartTime sets the StartTime field's value.

func (*GetDistributionMetricDataInput) SetStatistics added in v1.33.11 

func (s *GetDistributionMetricDataInput) SetStatistics(v []*string) *GetDistributionMetricDataInput

SetStatistics sets the Statistics field's value.

func (*GetDistributionMetricDataInput) SetUnit added in v1.33.11 

func (s *GetDistributionMetricDataInput) SetUnit(v string) *GetDistributionMetricDataInput

SetUnit sets the Unit field's value.

func (GetDistributionMetricDataInput) String added in v1.33.11 

func (s GetDistributionMetricDataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDistributionMetricDataInput) Validate added in v1.33.11 

func (s *GetDistributionMetricDataInput) Validate() error

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

type GetDistributionMetricDataOutput added in v1.33.11 

type GetDistributionMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The name of the metric returned.
	MetricName *string `locationName:"metricName" type:"string" enum:"DistributionMetricName"`
	// contains filtered or unexported fields
}

func (GetDistributionMetricDataOutput) GoString added in v1.33.11 

func (s GetDistributionMetricDataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDistributionMetricDataOutput) SetMetricData added in v1.33.11 

func (s *GetDistributionMetricDataOutput) SetMetricData(v []*MetricDatapoint) *GetDistributionMetricDataOutput

SetMetricData sets the MetricData field's value.

func (*GetDistributionMetricDataOutput) SetMetricName added in v1.33.11 

func (s *GetDistributionMetricDataOutput) SetMetricName(v string) *GetDistributionMetricDataOutput

SetMetricName sets the MetricName field's value.

func (GetDistributionMetricDataOutput) String added in v1.33.11 

func (s GetDistributionMetricDataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDistributionsInput added in v1.33.11 

type GetDistributionsInput struct {

	// The name of the distribution for which to return information.
	//
	// When omitted, the response includes all of your distributions in the Amazon
	// Web Services Region where the request is made.
	DistributionName *string `locationName:"distributionName" type:"string"`

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetDistributions request. If your
	// results are paginated, the response will return a next page token that you
	// can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDistributionsInput) GoString added in v1.33.11 

func (s GetDistributionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDistributionsInput) SetDistributionName added in v1.33.11 

func (s *GetDistributionsInput) SetDistributionName(v string) *GetDistributionsInput

SetDistributionName sets the DistributionName field's value.

func (*GetDistributionsInput) SetPageToken added in v1.33.11 

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

SetPageToken sets the PageToken field's value.

func (GetDistributionsInput) String added in v1.33.11 

func (s GetDistributionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDistributionsOutput added in v1.33.11 

type GetDistributionsOutput struct {

	// An array of objects that describe your distributions.
	Distributions []*LightsailDistribution `locationName:"distributions" type:"list"`

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetDistributions request
	// and specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDistributionsOutput) GoString added in v1.33.11 

func (s GetDistributionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDistributionsOutput) SetDistributions added in v1.33.11 

func (s *GetDistributionsOutput) SetDistributions(v []*LightsailDistribution) *GetDistributionsOutput

SetDistributions sets the Distributions field's value.

func (*GetDistributionsOutput) SetNextPageToken added in v1.33.11 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetDistributionsOutput) String added in v1.33.11 

func (s GetDistributionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDomainsInput 

type GetDomainsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetDomains request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDomainsInput) GoString 

func (s GetDomainsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetDomains request and specify
	// the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetDomainsOutput) GoString 

func (s GetDomainsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetExportSnapshotRecordsInput added in v1.15.86 

type GetExportSnapshotRecordsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetExportSnapshotRecords request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetExportSnapshotRecordsInput) GoString added in v1.15.86 

func (s GetExportSnapshotRecordsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetExportSnapshotRecordsInput) SetPageToken added in v1.15.86 

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

SetPageToken sets the PageToken field's value.

func (GetExportSnapshotRecordsInput) String added in v1.15.86 

func (s GetExportSnapshotRecordsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetExportSnapshotRecordsOutput added in v1.15.86 

type GetExportSnapshotRecordsOutput struct {

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetExportSnapshotRecords
	// request and specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetExportSnapshotRecordsOutput) GoString added in v1.15.86 

func (s GetExportSnapshotRecordsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetExportSnapshotRecordsOutput) SetExportSnapshotRecords added in v1.15.86 

func (s *GetExportSnapshotRecordsOutput) SetExportSnapshotRecords(v []*ExportSnapshotRecord) *GetExportSnapshotRecordsOutput

SetExportSnapshotRecords sets the ExportSnapshotRecords field's value.

func (*GetExportSnapshotRecordsOutput) SetNextPageToken added in v1.15.86 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetExportSnapshotRecordsOutput) String added in v1.15.86 

func (s GetExportSnapshotRecordsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s GetInstanceAccessDetailsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceAccessDetailsInput) SetInstanceName 

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

SetInstanceName sets the InstanceName field's value.

func (*GetInstanceAccessDetailsInput) SetProtocol 

func (s *GetInstanceAccessDetailsInput) SetProtocol(v string) *GetInstanceAccessDetailsInput

SetProtocol sets the Protocol field's value.

func (GetInstanceAccessDetailsInput) String 

func (s GetInstanceAccessDetailsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s GetInstanceAccessDetailsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceAccessDetailsOutput) SetAccessDetails 

func (s *GetInstanceAccessDetailsOutput) SetAccessDetails(v *InstanceAccessDetails) *GetInstanceAccessDetailsOutput

SetAccessDetails sets the AccessDetails field's value.

func (GetInstanceAccessDetailsOutput) String 

func (s GetInstanceAccessDetailsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 for which you want to return information.
	//
	// Valid instance metric names are listed below, along with the most useful
	// statistics to include in your request, and the published unit value.
	//
	//    * BurstCapacityPercentage - The percentage of CPU performance available
	//    for your instance to burst above its baseline. Your instance continuously
	//    accrues and consumes burst capacity. Burst capacity stops accruing when
	//    your instance's BurstCapacityPercentage reaches 100%. For more information,
	//    see Viewing instance burst capacity in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity).
	//    Statistics: The most useful statistics are Maximum and Average. Unit:
	//    The published unit is Percent.
	//
	//    * BurstCapacityTime - The available amount of time for your instance to
	//    burst at 100% CPU utilization. Your instance continuously accrues and
	//    consumes burst capacity. Burst capacity time stops accruing when your
	//    instance's BurstCapacityPercentage metric reaches 100%. Burst capacity
	//    time is consumed at the full rate only when your instance operates at
	//    100% CPU utilization. For example, if your instance operates at 50% CPU
	//    utilization in the burstable zone for a 5-minute period, then it consumes
	//    CPU burst capacity minutes at a 50% rate in that period. Your instance
	//    consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the
	//    5-minute period. For more information, see Viewing instance burst capacity
	//    in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity).
	//    Statistics: The most useful statistics are Maximum and Average. Unit:
	//    The published unit is Seconds.
	//
	//    * CPUUtilization - The percentage of allocated compute units that are
	//    currently in use on the instance. This metric identifies the processing
	//    power to run the applications on the instance. Tools in your operating
	//    system can show a lower percentage than Lightsail when the instance is
	//    not allocated a full processor core. Statistics: The most useful statistics
	//    are Maximum and Average. Unit: The published unit is Percent.
	//
	//    * NetworkIn - The number of bytes received on all network interfaces by
	//    the instance. This metric identifies the volume of incoming network traffic
	//    to the instance. The number reported is the number of bytes received during
	//    the period. Because this metric is reported in 5-minute intervals, divide
	//    the reported number by 300 to find Bytes/second. Statistics: The most
	//    useful statistic is Sum. Unit: The published unit is Bytes.
	//
	//    * NetworkOut - The number of bytes sent out on all network interfaces
	//    by the instance. This metric identifies the volume of outgoing network
	//    traffic from the instance. The number reported is the number of bytes
	//    sent during the period. Because this metric is reported in 5-minute intervals,
	//    divide the reported number by 300 to find Bytes/second. Statistics: The
	//    most useful statistic is Sum. Unit: The published unit is Bytes.
	//
	//    * StatusCheckFailed - Reports whether the instance passed or failed both
	//    the instance status check and the system status check. This metric can
	//    be either 0 (passed) or 1 (failed). This metric data is available in 1-minute
	//    (60 seconds) granularity. Statistics: The most useful statistic is Sum.
	//    Unit: The published unit is Count.
	//
	//    * StatusCheckFailed_Instance - Reports whether the instance passed or
	//    failed the instance status check. This metric can be either 0 (passed)
	//    or 1 (failed). This metric data is available in 1-minute (60 seconds)
	//    granularity. Statistics: The most useful statistic is Sum. Unit: The published
	//    unit is Count.
	//
	//    * StatusCheckFailed_System - Reports whether the instance passed or failed
	//    the system status check. This metric can be either 0 (passed) or 1 (failed).
	//    This metric data is available in 1-minute (60 seconds) granularity. Statistics:
	//    The most useful statistic is Sum. Unit: The published unit is Count.
	//
	//    * MetadataNoToken - Reports the number of times that the instance metadata
	//    service was successfully accessed without a token. This metric determines
	//    if there are any processes accessing instance metadata by using Instance
	//    Metadata Service Version 1, which doesn't use a token. If all requests
	//    use token-backed sessions, such as Instance Metadata Service Version 2,
	//    then the value is 0. Statistics: The most useful statistic is Sum. Unit:
	//    The published unit is Count.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"InstanceMetricName"`

	// The granularity, in seconds, of the returned data points.
	//
	// The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System
	// instance metric data is available in 1-minute (60 seconds) granularity. All
	// other instance metric data is available in 5-minute (300 seconds) granularity.
	//
	// 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 statistic for the metric.
	//
	// The following statistics are available:
	//
	//    * Minimum - The lowest value observed during the specified period. Use
	//    this value to determine low volumes of activity for your application.
	//
	//    * Maximum - The highest value observed during the specified period. Use
	//    this value to determine high volumes of activity for your application.
	//
	//    * Sum - All values submitted for the matching metric added together. You
	//    can use this statistic to determine the total volume of a metric.
	//
	//    * Average - The value of Sum / SampleCount during the specified period.
	//    By comparing this statistic with the Minimum and Maximum values, you can
	//    determine the full scope of a metric and how close the average use is
	//    to the Minimum and Maximum values. This comparison helps you to know when
	//    to increase or decrease your resources.
	//
	//    * SampleCount - The count, or number, of data points used for the statistical
	//    calculation.
	//
	// Statistics is a required field
	Statistics []*string `locationName:"statistics" type:"list" required:"true" enum:"MetricStatistic"`

	// The unit for the metric data request. Valid units depend on the metric data
	// being requested. For the valid units to specify with each available metric,
	// see the metricName parameter.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceMetricDataInput) SetEndTime 

func (s *GetInstanceMetricDataInput) SetEndTime(v time.Time) *GetInstanceMetricDataInput

SetEndTime sets the EndTime field's value.

func (*GetInstanceMetricDataInput) SetInstanceName 

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

SetInstanceName sets the InstanceName field's value.

func (*GetInstanceMetricDataInput) SetMetricName 

func (s *GetInstanceMetricDataInput) SetMetricName(v string) *GetInstanceMetricDataInput

SetMetricName sets the MetricName field's value.

func (*GetInstanceMetricDataInput) SetPeriod 

func (s *GetInstanceMetricDataInput) SetPeriod(v int64) *GetInstanceMetricDataInput

SetPeriod sets the Period field's value.

func (*GetInstanceMetricDataInput) SetStartTime 

func (s *GetInstanceMetricDataInput) SetStartTime(v time.Time) *GetInstanceMetricDataInput

SetStartTime sets the StartTime field's value.

func (*GetInstanceMetricDataInput) SetStatistics 

func (s *GetInstanceMetricDataInput) SetStatistics(v []*string) *GetInstanceMetricDataInput

SetStatistics sets the Statistics field's value.

func (*GetInstanceMetricDataInput) SetUnit 

func (s *GetInstanceMetricDataInput) SetUnit(v string) *GetInstanceMetricDataInput

SetUnit sets the Unit field's value.

func (GetInstanceMetricDataInput) String 

func (s GetInstanceMetricDataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the metric data returned.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The name of the metric returned.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceMetricDataOutput) SetMetricData 

func (s *GetInstanceMetricDataOutput) SetMetricData(v []*MetricDatapoint) *GetInstanceMetricDataOutput

SetMetricData sets the MetricData field's value.

func (*GetInstanceMetricDataOutput) SetMetricName 

func (s *GetInstanceMetricDataOutput) SetMetricName(v string) *GetInstanceMetricDataOutput

SetMetricName sets the MetricName field's value.

func (GetInstanceMetricDataOutput) String 

func (s GetInstanceMetricDataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInstancePortStatesInput 

type GetInstancePortStatesInput struct {

	// The name of the instance for which to return firewall port states.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstancePortStatesInput) SetInstanceName 

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

SetInstanceName sets the InstanceName field's value.

func (GetInstancePortStatesInput) String 

func (s GetInstancePortStatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// An array of objects that describe the firewall port states for the specified
	// instance.
	PortStates []*InstancePortState `locationName:"portStates" type:"list"`
	// contains filtered or unexported fields
}

func (GetInstancePortStatesOutput) GoString 

func (s GetInstancePortStatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstancePortStatesOutput) SetPortStates 

func (s *GetInstancePortStatesOutput) SetPortStates(v []*InstancePortState) *GetInstancePortStatesOutput

SetPortStates sets the PortStates field's value.

func (GetInstancePortStatesOutput) String 

func (s GetInstancePortStatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceSnapshotOutput) SetInstanceSnapshot 

func (s *GetInstanceSnapshotOutput) SetInstanceSnapshot(v *InstanceSnapshot) *GetInstanceSnapshotOutput

SetInstanceSnapshot sets the InstanceSnapshot field's value.

func (GetInstanceSnapshotOutput) String 

func (s GetInstanceSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInstanceSnapshotsInput 

type GetInstanceSnapshotsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetInstanceSnapshots request. If
	// your results are paginated, the response will return a next page token that
	// you can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetInstanceSnapshotsInput) GoString 

func (s GetInstanceSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceSnapshotsInput) SetPageToken 

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

SetPageToken sets the PageToken field's value.

func (GetInstanceSnapshotsInput) String 

func (s GetInstanceSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetInstanceSnapshots request
	// and specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetInstanceSnapshotsOutput) GoString 

func (s GetInstanceSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceSnapshotsOutput) SetInstanceSnapshots 

func (s *GetInstanceSnapshotsOutput) SetInstanceSnapshots(v []*InstanceSnapshot) *GetInstanceSnapshotsOutput

SetInstanceSnapshots sets the InstanceSnapshots field's value.

func (*GetInstanceSnapshotsOutput) SetNextPageToken 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetInstanceSnapshotsOutput) String 

func (s GetInstanceSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInstanceStateOutput) SetState 

func (s *GetInstanceStateOutput) SetState(v *InstanceState) *GetInstanceStateOutput

SetState sets the State field's value.

func (GetInstanceStateOutput) String 

func (s GetInstanceStateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInstancesInput 

type GetInstancesInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetInstances request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetInstancesInput) GoString 

func (s GetInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInstancesOutput 

type GetInstancesOutput struct {

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetInstances request and
	// specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetInstancesOutput) GoString 

func (s GetInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetKeyPairsInput 

type GetKeyPairsInput struct {

	// A Boolean value that indicates whether to include the default key pair in
	// the response of your request.
	IncludeDefaultKeyPair *bool `locationName:"includeDefaultKeyPair" type:"boolean"`

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetKeyPairs request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetKeyPairsInput) GoString 

func (s GetKeyPairsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKeyPairsInput) SetIncludeDefaultKeyPair added in v1.43.6 

func (s *GetKeyPairsInput) SetIncludeDefaultKeyPair(v bool) *GetKeyPairsInput

SetIncludeDefaultKeyPair sets the IncludeDefaultKeyPair field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetKeyPairsOutput 

type GetKeyPairsOutput struct {

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetKeyPairs request and
	// specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetKeyPairsOutput) GoString 

func (s GetKeyPairsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 for which you want to return information.
	//
	// Valid load balancer metric names are listed below, along with the most useful
	// statistics to include in your request, and the published unit value.
	//
	//    * ClientTLSNegotiationErrorCount - The number of TLS connections initiated
	//    by the client that did not establish a session with the load balancer
	//    due to a TLS error generated by the load balancer. Possible causes include
	//    a mismatch of ciphers or protocols. Statistics: The most useful statistic
	//    is Sum. Unit: The published unit is Count.
	//
	//    * HealthyHostCount - The number of target instances that are considered
	//    healthy. Statistics: The most useful statistic are Average, Minimum, and
	//    Maximum. Unit: The published unit is Count.
	//
	//    * HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes
	//    generated by the target instances. This does not include any response
	//    codes generated by the load balancer. Statistics: The most useful statistic
	//    is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The
	//    published unit is Count.
	//
	//    * HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes
	//    generated by the target instances. This does not include any response
	//    codes generated by the load balancer. Statistics: The most useful statistic
	//    is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The
	//    published unit is Count.
	//
	//    * HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes
	//    generated by the target instances. This does not include any response
	//    codes generated by the load balancer. Statistics: The most useful statistic
	//    is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The
	//    published unit is Count.
	//
	//    * HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes
	//    generated by the target instances. This does not include any response
	//    codes generated by the load balancer. Statistics: The most useful statistic
	//    is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The
	//    published unit is Count.
	//
	//    * HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that
	//    originated from the load balancer. Client errors are generated when requests
	//    are malformed or incomplete. These requests were not received by the target
	//    instance. This count does not include response codes generated by the
	//    target instances. Statistics: The most useful statistic is Sum. Note that
	//    Minimum, Maximum, and Average all return 1. Unit: The published unit is
	//    Count.
	//
	//    * HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that
	//    originated from the load balancer. This does not include any response
	//    codes generated by the target instance. This metric is reported if there
	//    are no healthy instances attached to the load balancer, or if the request
	//    rate exceeds the capacity of the instances (spillover) or the load balancer.
	//    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum,
	//    and Average all return 1. Unit: The published unit is Count.
	//
	//    * InstanceResponseTime - The time elapsed, in seconds, after the request
	//    leaves the load balancer until a response from the target instance is
	//    received. Statistics: The most useful statistic is Average. Unit: The
	//    published unit is Seconds.
	//
	//    * RejectedConnectionCount - The number of connections that were rejected
	//    because the load balancer had reached its maximum number of connections.
	//    Statistics: The most useful statistic is Sum. Unit: The published unit
	//    is Count.
	//
	//    * RequestCount - The number of requests processed over IPv4. This count
	//    includes only the requests with a response generated by a target instance
	//    of the load balancer. Statistics: The most useful statistic is Sum. Note
	//    that Minimum, Maximum, and Average all return 1. Unit: The published unit
	//    is Count.
	//
	//    * UnhealthyHostCount - The number of target instances that are considered
	//    unhealthy. Statistics: The most useful statistic are Average, Minimum,
	//    and Maximum. Unit: The published unit is Count.
	//
	// 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"`

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

	// The unit for the metric data request. Valid units depend on the metric data
	// being requested. For the valid units with each available metric, see the
	// metricName parameter.
	//
	// 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 

func (s GetLoadBalancerMetricDataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancerMetricDataInput) SetEndTime added in v1.12.37 

func (s *GetLoadBalancerMetricDataInput) SetEndTime(v time.Time) *GetLoadBalancerMetricDataInput

SetEndTime sets the EndTime field's value.

func (*GetLoadBalancerMetricDataInput) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*GetLoadBalancerMetricDataInput) SetMetricName added in v1.12.37 

func (s *GetLoadBalancerMetricDataInput) SetMetricName(v string) *GetLoadBalancerMetricDataInput

SetMetricName sets the MetricName field's value.

func (*GetLoadBalancerMetricDataInput) SetPeriod added in v1.12.37 

func (s *GetLoadBalancerMetricDataInput) SetPeriod(v int64) *GetLoadBalancerMetricDataInput

SetPeriod sets the Period field's value.

func (*GetLoadBalancerMetricDataInput) SetStartTime added in v1.12.37 

func (s *GetLoadBalancerMetricDataInput) SetStartTime(v time.Time) *GetLoadBalancerMetricDataInput

SetStartTime sets the StartTime field's value.

func (*GetLoadBalancerMetricDataInput) SetStatistics added in v1.12.37 

func (s *GetLoadBalancerMetricDataInput) SetStatistics(v []*string) *GetLoadBalancerMetricDataInput

SetStatistics sets the Statistics field's value.

func (*GetLoadBalancerMetricDataInput) SetUnit added in v1.12.37 

func (s *GetLoadBalancerMetricDataInput) SetUnit(v string) *GetLoadBalancerMetricDataInput

SetUnit sets the Unit field's value.

func (GetLoadBalancerMetricDataInput) String added in v1.12.37 

func (s GetLoadBalancerMetricDataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the metric data returned.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The name of the metric returned.
	MetricName *string `locationName:"metricName" type:"string" enum:"LoadBalancerMetricName"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerMetricDataOutput) GoString added in v1.12.37 

func (s GetLoadBalancerMetricDataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancerMetricDataOutput) SetMetricData added in v1.12.37 

func (s *GetLoadBalancerMetricDataOutput) SetMetricData(v []*MetricDatapoint) *GetLoadBalancerMetricDataOutput

SetMetricData sets the MetricData field's value.

func (*GetLoadBalancerMetricDataOutput) SetMetricName added in v1.12.37 

func (s *GetLoadBalancerMetricDataOutput) SetMetricName(v string) *GetLoadBalancerMetricDataOutput

SetMetricName sets the MetricName field's value.

func (GetLoadBalancerMetricDataOutput) String added in v1.12.37 

func (s GetLoadBalancerMetricDataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancerOutput) SetLoadBalancer added in v1.12.37 

func (s *GetLoadBalancerOutput) SetLoadBalancer(v *LoadBalancer) *GetLoadBalancerOutput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s GetLoadBalancerTlsCertificatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancerTlsCertificatesInput) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (GetLoadBalancerTlsCertificatesInput) String added in v1.12.37 

func (s GetLoadBalancerTlsCertificatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancerTlsCertificatesInput) Validate added in v1.12.37 

func (s *GetLoadBalancerTlsCertificatesInput) Validate() error

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 

func (s GetLoadBalancerTlsCertificatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancerTlsCertificatesOutput) SetTlsCertificates added in v1.12.37 

func (s *GetLoadBalancerTlsCertificatesOutput) SetTlsCertificates(v []*LoadBalancerTlsCertificate) *GetLoadBalancerTlsCertificatesOutput

SetTlsCertificates sets the TlsCertificates field's value.

func (GetLoadBalancerTlsCertificatesOutput) String added in v1.12.37 

func (s GetLoadBalancerTlsCertificatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLoadBalancerTlsPoliciesInput added in v1.44.1 

type GetLoadBalancerTlsPoliciesInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetLoadBalancerTlsPolicies request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerTlsPoliciesInput) GoString added in v1.44.1 

func (s GetLoadBalancerTlsPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancerTlsPoliciesInput) SetPageToken added in v1.44.1 

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

SetPageToken sets the PageToken field's value.

func (GetLoadBalancerTlsPoliciesInput) String added in v1.44.1 

func (s GetLoadBalancerTlsPoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLoadBalancerTlsPoliciesOutput added in v1.44.1 

type GetLoadBalancerTlsPoliciesOutput struct {

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

	// An array of objects that describe the TLS security policies that are available.
	TlsPolicies []*LoadBalancerTlsPolicy `locationName:"tlsPolicies" type:"list"`
	// contains filtered or unexported fields
}

func (GetLoadBalancerTlsPoliciesOutput) GoString added in v1.44.1 

func (s GetLoadBalancerTlsPoliciesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancerTlsPoliciesOutput) SetNextPageToken added in v1.44.1 

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

SetNextPageToken sets the NextPageToken field's value.

func (*GetLoadBalancerTlsPoliciesOutput) SetTlsPolicies added in v1.44.1 

func (s *GetLoadBalancerTlsPoliciesOutput) SetTlsPolicies(v []*LoadBalancerTlsPolicy) *GetLoadBalancerTlsPoliciesOutput

SetTlsPolicies sets the TlsPolicies field's value.

func (GetLoadBalancerTlsPoliciesOutput) String added in v1.44.1 

func (s GetLoadBalancerTlsPoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLoadBalancersInput added in v1.12.37 

type GetLoadBalancersInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetLoadBalancers request. If your
	// results are paginated, the response will return a next page token that you
	// can specify as the page token in a subsequent request.
	PageToken *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLoadBalancersInput) SetPageToken added in v1.12.37 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetLoadBalancers request
	// and specify the next page token using the pageToken parameter.
	NextPageToken *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (GetOperationOutput) GoString 

func (s GetOperationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetOperationsForResourceInput 

type GetOperationsForResourceInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetOperationsForResource request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `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 

func (s GetOperationsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetOperationsForResourceInput) SetPageToken 

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

SetPageToken sets the PageToken field's value.

func (*GetOperationsForResourceInput) SetResourceName 

func (s *GetOperationsForResourceInput) SetResourceName(v string) *GetOperationsForResourceInput

SetResourceName sets the ResourceName field's value.

func (GetOperationsForResourceInput) String 

func (s GetOperationsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (GetOperationsForResourceOutput) GoString 

func (s GetOperationsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetOperationsForResourceOutput) SetNextPageCount 

func (s *GetOperationsForResourceOutput) SetNextPageCount(v string) *GetOperationsForResourceOutput

SetNextPageCount sets the NextPageCount field's value.

func (*GetOperationsForResourceOutput) SetNextPageToken added in v1.10.2 

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

SetNextPageToken sets the NextPageToken field's value.

func (*GetOperationsForResourceOutput) SetOperations 

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

SetOperations sets the Operations field's value.

func (GetOperationsForResourceOutput) String 

func (s GetOperationsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetOperationsInput 

type GetOperationsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetOperations request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetOperationsInput) GoString 

func (s GetOperationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetOperationsOutput 

type GetOperationsOutput struct {

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

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (GetOperationsOutput) GoString 

func (s GetOperationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRegionsInput) SetIncludeAvailabilityZones 

func (s *GetRegionsInput) SetIncludeAvailabilityZones(v bool) *GetRegionsInput

SetIncludeAvailabilityZones sets the IncludeAvailabilityZones field's value.

func (*GetRegionsInput) SetIncludeRelationalDatabaseAvailabilityZones added in v1.15.56 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseBlueprintsInput added in v1.15.56 

type GetRelationalDatabaseBlueprintsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetRelationalDatabaseBlueprints request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseBlueprintsInput) GoString added in v1.15.56 

func (s GetRelationalDatabaseBlueprintsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseBlueprintsInput) SetPageToken added in v1.15.56 

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

SetPageToken sets the PageToken field's value.

func (GetRelationalDatabaseBlueprintsInput) String added in v1.15.56 

func (s GetRelationalDatabaseBlueprintsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseBlueprintsOutput added in v1.15.56 

type GetRelationalDatabaseBlueprintsOutput struct {

	// An object describing the result of your get relational database blueprints
	// request.
	Blueprints []*RelationalDatabaseBlueprint `locationName:"blueprints" type:"list"`

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetRelationalDatabaseBlueprints
	// request and specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseBlueprintsOutput) GoString added in v1.15.56 

func (s GetRelationalDatabaseBlueprintsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseBlueprintsOutput) SetBlueprints added in v1.15.56 

func (s *GetRelationalDatabaseBlueprintsOutput) SetBlueprints(v []*RelationalDatabaseBlueprint) *GetRelationalDatabaseBlueprintsOutput

SetBlueprints sets the Blueprints field's value.

func (*GetRelationalDatabaseBlueprintsOutput) SetNextPageToken added in v1.15.56 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetRelationalDatabaseBlueprintsOutput) String added in v1.15.56 

func (s GetRelationalDatabaseBlueprintsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseBundlesInput added in v1.15.56 

type GetRelationalDatabaseBundlesInput struct {

	// A Boolean value that indicates whether to include inactive (unavailable)
	// bundles in the response of your request.
	IncludeInactive *bool `locationName:"includeInactive" type:"boolean"`

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetRelationalDatabaseBundles request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseBundlesInput) GoString added in v1.15.56 

func (s GetRelationalDatabaseBundlesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseBundlesInput) SetIncludeInactive added in v1.44.13 

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

SetIncludeInactive sets the IncludeInactive field's value.

func (*GetRelationalDatabaseBundlesInput) SetPageToken added in v1.15.56 

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

SetPageToken sets the PageToken field's value.

func (GetRelationalDatabaseBundlesInput) String added in v1.15.56 

func (s GetRelationalDatabaseBundlesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseBundlesOutput added in v1.15.56 

type GetRelationalDatabaseBundlesOutput struct {

	// An object describing the result of your get relational database bundles request.
	Bundles []*RelationalDatabaseBundle `locationName:"bundles" type:"list"`

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetRelationalDatabaseBundles
	// request and specify the next page token using the pageToken parameter.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseBundlesOutput) GoString added in v1.15.56 

func (s GetRelationalDatabaseBundlesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseBundlesOutput) SetBundles added in v1.15.56 

func (s *GetRelationalDatabaseBundlesOutput) SetBundles(v []*RelationalDatabaseBundle) *GetRelationalDatabaseBundlesOutput

SetBundles sets the Bundles field's value.

func (*GetRelationalDatabaseBundlesOutput) SetNextPageToken added in v1.15.56 

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

SetNextPageToken sets the NextPageToken field's value.

func (GetRelationalDatabaseBundlesOutput) String added in v1.15.56 

func (s GetRelationalDatabaseBundlesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseEventsInput added in v1.15.56 

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

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetRelationalDatabaseEvents request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `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.15.56 

func (s GetRelationalDatabaseEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseEventsInput) SetDurationInMinutes added in v1.15.56 

func (s *GetRelationalDatabaseEventsInput) SetDurationInMinutes(v int64) *GetRelationalDatabaseEventsInput

SetDurationInMinutes sets the DurationInMinutes field's value.

func (*GetRelationalDatabaseEventsInput) SetPageToken added in v1.15.56 

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

SetPageToken sets the PageToken field's value.

func (*GetRelationalDatabaseEventsInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseEventsInput) String added in v1.15.56 

func (s GetRelationalDatabaseEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseEventsInput) Validate added in v1.15.56 

func (s *GetRelationalDatabaseEventsInput) Validate() error

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

type GetRelationalDatabaseEventsOutput added in v1.15.56 

type GetRelationalDatabaseEventsOutput struct {

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetRelationalDatabaseEvents
	// request and specify the next page token using the pageToken parameter.
	NextPageToken *string `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.15.56 

func (s GetRelationalDatabaseEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseEventsOutput) SetNextPageToken added in v1.15.56 

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

SetNextPageToken sets the NextPageToken field's value.

func (*GetRelationalDatabaseEventsOutput) SetRelationalDatabaseEvents added in v1.15.56 

func (s *GetRelationalDatabaseEventsOutput) SetRelationalDatabaseEvents(v []*RelationalDatabaseEvent) *GetRelationalDatabaseEventsOutput

SetRelationalDatabaseEvents sets the RelationalDatabaseEvents field's value.

func (GetRelationalDatabaseEventsOutput) String added in v1.15.56 

func (s GetRelationalDatabaseEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseInput added in v1.15.56 

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

func (s GetRelationalDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseInput) String added in v1.15.56 

func (s GetRelationalDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseInput) Validate added in v1.15.56 

func (s *GetRelationalDatabaseInput) Validate() error

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

type GetRelationalDatabaseLogEventsInput added in v1.15.56 

type GetRelationalDatabaseLogEventsInput struct {

	// The end of the time interval from which to get log events.
	//
	// Constraints:
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use an
	//    end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as
	//    the end time.
	EndTime *time.Time `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"`

	// The token to advance to the next or previous page of results from your request.
	//
	// To get a page token, perform an initial GetRelationalDatabaseLogEvents request.
	// If your results are paginated, the response will return a next forward token
	// and/or next backward token that you can specify as the page token in a subsequent
	// request.
	PageToken *string `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.
	//
	// For PostgreSQL, the default value of false is the only option available.
	StartFromHead *bool `locationName:"startFromHead" type:"boolean"`

	// The start of the time interval from which to get log events.
	//
	// Constraints:
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use a
	//    start time of October 1, 2018, at 8 PM UTC, then you input 1538424000
	//    as the start time.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseLogEventsInput) GoString added in v1.15.56 

func (s GetRelationalDatabaseLogEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseLogEventsInput) SetEndTime added in v1.15.56 

func (s *GetRelationalDatabaseLogEventsInput) SetEndTime(v time.Time) *GetRelationalDatabaseLogEventsInput

SetEndTime sets the EndTime field's value.

func (*GetRelationalDatabaseLogEventsInput) SetLogStreamName added in v1.15.56 

func (s *GetRelationalDatabaseLogEventsInput) SetLogStreamName(v string) *GetRelationalDatabaseLogEventsInput

SetLogStreamName sets the LogStreamName field's value.

func (*GetRelationalDatabaseLogEventsInput) SetPageToken added in v1.15.56 

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

SetPageToken sets the PageToken field's value.

func (*GetRelationalDatabaseLogEventsInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*GetRelationalDatabaseLogEventsInput) SetStartFromHead added in v1.15.56 

func (s *GetRelationalDatabaseLogEventsInput) SetStartFromHead(v bool) *GetRelationalDatabaseLogEventsInput

SetStartFromHead sets the StartFromHead field's value.

func (*GetRelationalDatabaseLogEventsInput) SetStartTime added in v1.15.56 

func (s *GetRelationalDatabaseLogEventsInput) SetStartTime(v time.Time) *GetRelationalDatabaseLogEventsInput

SetStartTime sets the StartTime field's value.

func (GetRelationalDatabaseLogEventsInput) String added in v1.15.56 

func (s GetRelationalDatabaseLogEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseLogEventsInput) Validate added in v1.15.56 

func (s *GetRelationalDatabaseLogEventsInput) Validate() error

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

type GetRelationalDatabaseLogEventsOutput added in v1.15.56 

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

func (s GetRelationalDatabaseLogEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseLogEventsOutput) SetNextBackwardToken added in v1.15.56 

func (s *GetRelationalDatabaseLogEventsOutput) SetNextBackwardToken(v string) *GetRelationalDatabaseLogEventsOutput

SetNextBackwardToken sets the NextBackwardToken field's value.

func (*GetRelationalDatabaseLogEventsOutput) SetNextForwardToken added in v1.15.56 

func (s *GetRelationalDatabaseLogEventsOutput) SetNextForwardToken(v string) *GetRelationalDatabaseLogEventsOutput

SetNextForwardToken sets the NextForwardToken field's value.

func (*GetRelationalDatabaseLogEventsOutput) SetResourceLogEvents added in v1.15.56 

func (s *GetRelationalDatabaseLogEventsOutput) SetResourceLogEvents(v []*LogEvent) *GetRelationalDatabaseLogEventsOutput

SetResourceLogEvents sets the ResourceLogEvents field's value.

func (GetRelationalDatabaseLogEventsOutput) String added in v1.15.56 

func (s GetRelationalDatabaseLogEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseLogStreamsInput added in v1.15.56 

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

func (s GetRelationalDatabaseLogStreamsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseLogStreamsInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseLogStreamsInput) String added in v1.15.56 

func (s GetRelationalDatabaseLogStreamsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseLogStreamsInput) Validate added in v1.15.56 

func (s *GetRelationalDatabaseLogStreamsInput) Validate() error

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

type GetRelationalDatabaseLogStreamsOutput added in v1.15.56 

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

func (s GetRelationalDatabaseLogStreamsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseLogStreamsOutput) SetLogStreams added in v1.15.56 

func (s *GetRelationalDatabaseLogStreamsOutput) SetLogStreams(v []*string) *GetRelationalDatabaseLogStreamsOutput

SetLogStreams sets the LogStreams field's value.

func (GetRelationalDatabaseLogStreamsOutput) String added in v1.15.56 

func (s GetRelationalDatabaseLogStreamsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseMasterUserPasswordInput added in v1.15.56 

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

func (s GetRelationalDatabaseMasterUserPasswordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseMasterUserPasswordInput) SetPasswordVersion added in v1.15.56 

func (s *GetRelationalDatabaseMasterUserPasswordInput) SetPasswordVersion(v string) *GetRelationalDatabaseMasterUserPasswordInput

SetPasswordVersion sets the PasswordVersion field's value.

func (*GetRelationalDatabaseMasterUserPasswordInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseMasterUserPasswordInput) String added in v1.15.56 

func (s GetRelationalDatabaseMasterUserPasswordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseMasterUserPasswordInput) Validate added in v1.15.56 

func (s *GetRelationalDatabaseMasterUserPasswordInput) Validate() error

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

type GetRelationalDatabaseMasterUserPasswordOutput added in v1.15.56 

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetRelationalDatabaseMasterUserPasswordOutput's
	// String and GoString methods.
	MasterUserPassword *string `locationName:"masterUserPassword" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseMasterUserPasswordOutput) GoString added in v1.15.56 

func (s GetRelationalDatabaseMasterUserPasswordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseMasterUserPasswordOutput) SetCreatedAt added in v1.15.56 

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

SetCreatedAt sets the CreatedAt field's value.

func (*GetRelationalDatabaseMasterUserPasswordOutput) SetMasterUserPassword added in v1.15.56 

func (s *GetRelationalDatabaseMasterUserPasswordOutput) SetMasterUserPassword(v string) *GetRelationalDatabaseMasterUserPasswordOutput

SetMasterUserPassword sets the MasterUserPassword field's value.

func (GetRelationalDatabaseMasterUserPasswordOutput) String added in v1.15.56 

func (s GetRelationalDatabaseMasterUserPasswordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseMetricDataInput added in v1.15.56 

type GetRelationalDatabaseMetricDataInput struct {

	// The end of the time interval from which to get metric data.
	//
	// Constraints:
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use an
	//    end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as
	//    the end time.
	//
	// EndTime is a required field
	EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"`

	// The metric for which you want to return information.
	//
	// Valid relational database metric names are listed below, along with the most
	// useful statistics to include in your request, and the published unit value.
	// All relational database metric data is available in 1-minute (60 seconds)
	// granularity.
	//
	//    * CPUUtilization - The percentage of CPU utilization currently in use
	//    on the database. Statistics: The most useful statistics are Maximum and
	//    Average. Unit: The published unit is Percent.
	//
	//    * DatabaseConnections - The number of database connections in use. Statistics:
	//    The most useful statistics are Maximum and Sum. Unit: The published unit
	//    is Count.
	//
	//    * DiskQueueDepth - The number of outstanding IOs (read/write requests)
	//    that are waiting to access the disk. Statistics: The most useful statistic
	//    is Sum. Unit: The published unit is Count.
	//
	//    * FreeStorageSpace - The amount of available storage space. Statistics:
	//    The most useful statistic is Sum. Unit: The published unit is Bytes.
	//
	//    * NetworkReceiveThroughput - The incoming (Receive) network traffic on
	//    the database, including both customer database traffic and AWS traffic
	//    used for monitoring and replication. Statistics: The most useful statistic
	//    is Average. Unit: The published unit is Bytes/Second.
	//
	//    * NetworkTransmitThroughput - The outgoing (Transmit) network traffic
	//    on the database, including both customer database traffic and AWS traffic
	//    used for monitoring and replication. Statistics: The most useful statistic
	//    is Average. Unit: The published unit is Bytes/Second.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"RelationalDatabaseMetricName"`

	// The granularity, in seconds, of the returned data points.
	//
	// All relational database metric data is available in 1-minute (60 seconds)
	// granularity.
	//
	// 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 Coordinated Universal Time (UTC).
	//
	//    * Specified in the Unix time format. For example, if you wish to use a
	//    start time of October 1, 2018, at 8 PM UTC, then you input 1538424000
	//    as the start time.
	//
	// StartTime is a required field
	StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"`

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

	// The unit for the metric data request. Valid units depend on the metric data
	// being requested. For the valid units with each available metric, see the
	// metricName parameter.
	//
	// 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.15.56 

func (s GetRelationalDatabaseMetricDataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseMetricDataInput) SetEndTime added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataInput) SetEndTime(v time.Time) *GetRelationalDatabaseMetricDataInput

SetEndTime sets the EndTime field's value.

func (*GetRelationalDatabaseMetricDataInput) SetMetricName added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataInput) SetMetricName(v string) *GetRelationalDatabaseMetricDataInput

SetMetricName sets the MetricName field's value.

func (*GetRelationalDatabaseMetricDataInput) SetPeriod added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataInput) SetPeriod(v int64) *GetRelationalDatabaseMetricDataInput

SetPeriod sets the Period field's value.

func (*GetRelationalDatabaseMetricDataInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*GetRelationalDatabaseMetricDataInput) SetStartTime added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataInput) SetStartTime(v time.Time) *GetRelationalDatabaseMetricDataInput

SetStartTime sets the StartTime field's value.

func (*GetRelationalDatabaseMetricDataInput) SetStatistics added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataInput) SetStatistics(v []*string) *GetRelationalDatabaseMetricDataInput

SetStatistics sets the Statistics field's value.

func (*GetRelationalDatabaseMetricDataInput) SetUnit added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataInput) SetUnit(v string) *GetRelationalDatabaseMetricDataInput

SetUnit sets the Unit field's value.

func (GetRelationalDatabaseMetricDataInput) String added in v1.15.56 

func (s GetRelationalDatabaseMetricDataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseMetricDataInput) Validate added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataInput) Validate() error

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

type GetRelationalDatabaseMetricDataOutput added in v1.15.56 

type GetRelationalDatabaseMetricDataOutput struct {

	// An array of objects that describe the metric data returned.
	MetricData []*MetricDatapoint `locationName:"metricData" type:"list"`

	// The name of the metric returned.
	MetricName *string `locationName:"metricName" type:"string" enum:"RelationalDatabaseMetricName"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseMetricDataOutput) GoString added in v1.15.56 

func (s GetRelationalDatabaseMetricDataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseMetricDataOutput) SetMetricData added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataOutput) SetMetricData(v []*MetricDatapoint) *GetRelationalDatabaseMetricDataOutput

SetMetricData sets the MetricData field's value.

func (*GetRelationalDatabaseMetricDataOutput) SetMetricName added in v1.15.56 

func (s *GetRelationalDatabaseMetricDataOutput) SetMetricName(v string) *GetRelationalDatabaseMetricDataOutput

SetMetricName sets the MetricName field's value.

func (GetRelationalDatabaseMetricDataOutput) String added in v1.15.56 

func (s GetRelationalDatabaseMetricDataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseOutput added in v1.15.56 

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

func (s GetRelationalDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseOutput) SetRelationalDatabase added in v1.15.56 

func (s *GetRelationalDatabaseOutput) SetRelationalDatabase(v *RelationalDatabase) *GetRelationalDatabaseOutput

SetRelationalDatabase sets the RelationalDatabase field's value.

func (GetRelationalDatabaseOutput) String added in v1.15.56 

func (s GetRelationalDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseParametersInput added in v1.15.56 

type GetRelationalDatabaseParametersInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetRelationalDatabaseParameters request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `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.15.56 

func (s GetRelationalDatabaseParametersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseParametersInput) SetPageToken added in v1.15.56 

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

SetPageToken sets the PageToken field's value.

func (*GetRelationalDatabaseParametersInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (GetRelationalDatabaseParametersInput) String added in v1.15.56 

func (s GetRelationalDatabaseParametersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseParametersInput) Validate added in v1.15.56 

func (s *GetRelationalDatabaseParametersInput) Validate() error

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

type GetRelationalDatabaseParametersOutput added in v1.15.56 

type GetRelationalDatabaseParametersOutput struct {

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetRelationalDatabaseParameters
	// request and specify the next page token using the pageToken parameter.
	NextPageToken *string `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.15.56 

func (s GetRelationalDatabaseParametersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseParametersOutput) SetNextPageToken added in v1.15.56 

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

SetNextPageToken sets the NextPageToken field's value.

func (*GetRelationalDatabaseParametersOutput) SetParameters added in v1.15.56 

func (s *GetRelationalDatabaseParametersOutput) SetParameters(v []*RelationalDatabaseParameter) *GetRelationalDatabaseParametersOutput

SetParameters sets the Parameters field's value.

func (GetRelationalDatabaseParametersOutput) String added in v1.15.56 

func (s GetRelationalDatabaseParametersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseSnapshotInput added in v1.15.56 

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

func (s GetRelationalDatabaseSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName added in v1.15.56 

func (s *GetRelationalDatabaseSnapshotInput) SetRelationalDatabaseSnapshotName(v string) *GetRelationalDatabaseSnapshotInput

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (GetRelationalDatabaseSnapshotInput) String added in v1.15.56 

func (s GetRelationalDatabaseSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseSnapshotInput) Validate added in v1.15.56 

func (s *GetRelationalDatabaseSnapshotInput) Validate() error

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

type GetRelationalDatabaseSnapshotOutput added in v1.15.56 

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

func (s GetRelationalDatabaseSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseSnapshotOutput) SetRelationalDatabaseSnapshot added in v1.15.56 

func (s *GetRelationalDatabaseSnapshotOutput) SetRelationalDatabaseSnapshot(v *RelationalDatabaseSnapshot) *GetRelationalDatabaseSnapshotOutput

SetRelationalDatabaseSnapshot sets the RelationalDatabaseSnapshot field's value.

func (GetRelationalDatabaseSnapshotOutput) String added in v1.15.56 

func (s GetRelationalDatabaseSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseSnapshotsInput added in v1.15.56 

type GetRelationalDatabaseSnapshotsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetRelationalDatabaseSnapshots request.
	// If your results are paginated, the response will return a next page token
	// that you can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabaseSnapshotsInput) GoString added in v1.15.56 

func (s GetRelationalDatabaseSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseSnapshotsInput) SetPageToken added in v1.15.56 

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

SetPageToken sets the PageToken field's value.

func (GetRelationalDatabaseSnapshotsInput) String added in v1.15.56 

func (s GetRelationalDatabaseSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabaseSnapshotsOutput added in v1.15.56 

type GetRelationalDatabaseSnapshotsOutput struct {

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetRelationalDatabaseSnapshots
	// request and specify the next page token using the pageToken parameter.
	NextPageToken *string `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.15.56 

func (s GetRelationalDatabaseSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabaseSnapshotsOutput) SetNextPageToken added in v1.15.56 

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

SetNextPageToken sets the NextPageToken field's value.

func (*GetRelationalDatabaseSnapshotsOutput) SetRelationalDatabaseSnapshots added in v1.15.56 

func (s *GetRelationalDatabaseSnapshotsOutput) SetRelationalDatabaseSnapshots(v []*RelationalDatabaseSnapshot) *GetRelationalDatabaseSnapshotsOutput

SetRelationalDatabaseSnapshots sets the RelationalDatabaseSnapshots field's value.

func (GetRelationalDatabaseSnapshotsOutput) String added in v1.15.56 

func (s GetRelationalDatabaseSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabasesInput added in v1.15.56 

type GetRelationalDatabasesInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetRelationalDatabases request. If
	// your results are paginated, the response will return a next page token that
	// you can specify as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetRelationalDatabasesInput) GoString added in v1.15.56 

func (s GetRelationalDatabasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabasesInput) SetPageToken added in v1.15.56 

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

SetPageToken sets the PageToken field's value.

func (GetRelationalDatabasesInput) String added in v1.15.56 

func (s GetRelationalDatabasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRelationalDatabasesOutput added in v1.15.56 

type GetRelationalDatabasesOutput struct {

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetRelationalDatabases request
	// and specify the next page token using the pageToken parameter.
	NextPageToken *string `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.15.56 

func (s GetRelationalDatabasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRelationalDatabasesOutput) SetNextPageToken added in v1.15.56 

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

SetNextPageToken sets the NextPageToken field's value.

func (*GetRelationalDatabasesOutput) SetRelationalDatabases added in v1.15.56 

func (s *GetRelationalDatabasesOutput) SetRelationalDatabases(v []*RelationalDatabase) *GetRelationalDatabasesOutput

SetRelationalDatabases sets the RelationalDatabases field's value.

func (GetRelationalDatabasesOutput) String added in v1.15.56 

func (s GetRelationalDatabasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetStaticIpsInput 

type GetStaticIpsInput struct {

	// The token to advance to the next page of results from your request.
	//
	// To get a page token, perform an initial GetStaticIps request. If your results
	// are paginated, the response will return a next page token that you can specify
	// as the page token in a subsequent request.
	PageToken *string `locationName:"pageToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetStaticIpsInput) GoString 

func (s GetStaticIpsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetStaticIpsOutput 

type GetStaticIpsOutput struct {

	// The token to advance to the next page of results from your request.
	//
	// A next page token is not returned if there are no more results to display.
	//
	// To get the next page of results, perform another GetStaticIps request and
	// specify the next page token using the pageToken parameter.
	NextPageToken *string `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HeaderObject added in v1.33.11 

type HeaderObject struct {

	// The specific headers to forward to your distribution's origin.
	HeadersAllowList []*string `locationName:"headersAllowList" type:"list" enum:"HeaderEnum"`

	// The headers that you want your distribution to forward to your origin and
	// base caching on.
	//
	// You can configure your distribution to do one of the following:
	//
	//    * all - Forward all headers to your origin.
	//
	//    * none - Forward only the default headers.
	//
	//    * allow-list - Forward only the headers you specify using the headersAllowList
	//    parameter.
	Option *string `locationName:"option" type:"string" enum:"ForwardValues"`
	// contains filtered or unexported fields
}

Describes the request headers that a Lightsail distribution bases caching on.

For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.

func (HeaderObject) GoString added in v1.33.11 

func (s HeaderObject) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HeaderObject) SetHeadersAllowList added in v1.33.11 

func (s *HeaderObject) SetHeadersAllowList(v []*string) *HeaderObject

SetHeadersAllowList sets the HeadersAllowList field's value.

func (*HeaderObject) SetOption added in v1.33.11 

func (s *HeaderObject) SetOption(v string) *HeaderObject

SetOption sets the Option field's value.

func (HeaderObject) String added in v1.33.11 

func (s HeaderObject) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HostKeyAttributes added in v1.19.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.19.0 

func (s HostKeyAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HostKeyAttributes) SetAlgorithm added in v1.19.0 

func (s *HostKeyAttributes) SetAlgorithm(v string) *HostKeyAttributes

SetAlgorithm sets the Algorithm field's value.

func (*HostKeyAttributes) SetFingerprintSHA1 added in v1.19.0 

func (s *HostKeyAttributes) SetFingerprintSHA1(v string) *HostKeyAttributes

SetFingerprintSHA1 sets the FingerprintSHA1 field's value.

func (*HostKeyAttributes) SetFingerprintSHA256 added in v1.19.0 

func (s *HostKeyAttributes) SetFingerprintSHA256(v string) *HostKeyAttributes

SetFingerprintSHA256 sets the FingerprintSHA256 field's value.

func (*HostKeyAttributes) SetNotValidAfter added in v1.19.0 

func (s *HostKeyAttributes) SetNotValidAfter(v time.Time) *HostKeyAttributes

SetNotValidAfter sets the NotValidAfter field's value.

func (*HostKeyAttributes) SetNotValidBefore added in v1.19.0 

func (s *HostKeyAttributes) SetNotValidBefore(v time.Time) *HostKeyAttributes

SetNotValidBefore sets the NotValidBefore field's value.

func (*HostKeyAttributes) SetPublicKey added in v1.19.0 

func (s *HostKeyAttributes) SetPublicKey(v string) *HostKeyAttributes

SetPublicKey sets the PublicKey field's value.

func (*HostKeyAttributes) SetWitnessedAt added in v1.19.0 

func (s *HostKeyAttributes) SetWitnessedAt(v time.Time) *HostKeyAttributes

SetWitnessedAt sets the WitnessedAt field's value.

func (HostKeyAttributes) String added in v1.19.0 

func (s HostKeyAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (ImportKeyPairOutput) GoString 

func (s ImportKeyPairOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputOrigin added in v1.33.11 

type InputOrigin struct {

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

	// The protocol that your Amazon Lightsail distribution uses when establishing
	// a connection with your origin to pull content.
	ProtocolPolicy *string `locationName:"protocolPolicy" type:"string" enum:"OriginProtocolPolicyEnum"`

	// The AWS Region name of the origin resource.
	RegionName *string `locationName:"regionName" type:"string" enum:"RegionName"`
	// contains filtered or unexported fields
}

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

func (InputOrigin) GoString added in v1.33.11 

func (s InputOrigin) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputOrigin) SetName added in v1.33.11 

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

SetName sets the Name field's value.

func (*InputOrigin) SetProtocolPolicy added in v1.33.11 

func (s *InputOrigin) SetProtocolPolicy(v string) *InputOrigin

SetProtocolPolicy sets the ProtocolPolicy field's value.

func (*InputOrigin) SetRegionName added in v1.33.11 

func (s *InputOrigin) SetRegionName(v string) *InputOrigin

SetRegionName sets the RegionName field's value.

func (InputOrigin) String added in v1.33.11 

func (s InputOrigin) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Instance 

type Instance struct {

	// An array of objects representing the add-ons enabled on the instance.
	AddOns []*AddOn `locationName:"addOns" type:"list"`

	// 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) in Unix
	// time format.
	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 IP address type of the instance.
	//
	// The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	IpAddressType *string `locationName:"ipAddressType" type:"string" enum:"IpAddressType"`

	// The IPv6 addresses of the instance.
	Ipv6Addresses []*string `locationName:"ipv6Addresses" type:"list"`

	// 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 metadata options for the Amazon Lightsail instance.
	MetadataOptions *InstanceMetadataOptions `locationName:"metadataOptions" 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Instance) SetAddOns added in v1.25.4 

func (s *Instance) SetAddOns(v []*AddOn) *Instance

SetAddOns sets the AddOns field's value.

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) SetIpAddressType added in v1.36.25 

func (s *Instance) SetIpAddressType(v string) *Instance

SetIpAddressType sets the IpAddressType field's value.

func (*Instance) SetIpv6Addresses added in v1.36.25 

func (s *Instance) SetIpv6Addresses(v []*string) *Instance

SetIpv6Addresses sets the Ipv6Addresses 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) SetMetadataOptions added in v1.44.105 

func (s *Instance) SetMetadataOptions(v *InstanceMetadataOptions) *Instance

SetMetadataOptions sets the MetadataOptions 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.15.86 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceAccessDetails) SetCertKey 

func (s *InstanceAccessDetails) SetCertKey(v string) *InstanceAccessDetails

SetCertKey sets the CertKey field's value.

func (*InstanceAccessDetails) SetExpiresAt 

func (s *InstanceAccessDetails) SetExpiresAt(v time.Time) *InstanceAccessDetails

SetExpiresAt sets the ExpiresAt field's value.

func (*InstanceAccessDetails) SetHostKeys added in v1.19.0 

func (s *InstanceAccessDetails) SetHostKeys(v []*HostKeyAttributes) *InstanceAccessDetails

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 

func (s *InstanceAccessDetails) SetIpAddress(v string) *InstanceAccessDetails

SetIpAddress sets the IpAddress field's value.

func (*InstanceAccessDetails) SetPassword 

func (s *InstanceAccessDetails) SetPassword(v string) *InstanceAccessDetails

SetPassword sets the Password field's value.

func (*InstanceAccessDetails) SetPasswordData added in v1.12.13 

func (s *InstanceAccessDetails) SetPasswordData(v *PasswordData) *InstanceAccessDetails

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 

func (s *InstanceAccessDetails) SetProtocol(v string) *InstanceAccessDetails

SetProtocol sets the Protocol field's value.

func (*InstanceAccessDetails) SetUsername 

func (s *InstanceAccessDetails) SetUsername(v string) *InstanceAccessDetails

SetUsername sets the Username field's value.

func (InstanceAccessDetails) String 

func (s InstanceAccessDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceEntry added in v1.15.86 

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 Lightsail instance
	//    blueprint. If this is specified, then IPv4 and IPv6 will be configured
	//    for the new instance that is created in Amazon EC2.
	//
	//    * INSTANCE - Use the configured firewall settings from the source Lightsail
	//    instance. If this is specified, the new instance that is created in Amazon
	//    EC2 will be configured to match the configuration of the source Lightsail
	//    instance. For example, if the source instance is configured for dual-stack
	//    (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance
	//    that is created in Amazon EC2. If the source instance is configured for
	//    IPv4 only, then only IPv4 will be configured for the new instance that
	//    is created in Amazon EC2.
	//
	//    * NONE - Use the default Amazon EC2 security group. If this is specified,
	//    then only IPv4 will be configured for the new instance that is created
	//    in Amazon EC2.
	//
	//    * CLOSED - All ports closed. If this is specified, then only IPv4 will
	//    be configured for the new instance that is created in Amazon EC2.
	//
	// If you configured lightsail-connect as a cidrListAliases on your instance,
	// or if you chose to allow the Lightsail browser-based SSH or RDP clients to
	// connect to your instance, that configuration is not carried over to your
	// new Amazon EC2 instance.
	//
	// 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.15.86 

func (s InstanceEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceEntry) SetAvailabilityZone added in v1.15.86 

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*InstanceEntry) SetInstanceType added in v1.15.86 

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

SetInstanceType sets the InstanceType field's value.

func (*InstanceEntry) SetPortInfoSource added in v1.15.86 

func (s *InstanceEntry) SetPortInfoSource(v string) *InstanceEntry

SetPortInfoSource sets the PortInfoSource field's value.

func (*InstanceEntry) SetSourceName added in v1.15.86 

func (s *InstanceEntry) SetSourceName(v string) *InstanceEntry

SetSourceName sets the SourceName field's value.

func (*InstanceEntry) SetUserData added in v1.15.86 

func (s *InstanceEntry) SetUserData(v string) *InstanceEntry

SetUserData sets the UserData field's value.

func (InstanceEntry) String added in v1.15.86 

func (s InstanceEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceEntry) Validate added in v1.15.86 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceMetadataOptions added in v1.44.105 

type InstanceMetadataOptions struct {

	// Indicates whether the HTTP metadata endpoint on your instances is enabled
	// or disabled.
	//
	// If the value is disabled, you cannot access your instance metadata.
	HttpEndpoint *string `locationName:"httpEndpoint" type:"string" enum:"HttpEndpoint"`

	// Indicates whether the IPv6 endpoint for the instance metadata service is
	// enabled or disabled.
	HttpProtocolIpv6 *string `locationName:"httpProtocolIpv6" type:"string" enum:"HttpProtocolIpv6"`

	// The desired HTTP PUT response hop limit for instance metadata requests. A
	// larger number means that the instance metadata requests can travel farther.
	HttpPutResponseHopLimit *int64 `locationName:"httpPutResponseHopLimit" type:"integer"`

	// The state of token usage for your instance metadata requests.
	//
	// If the state is optional, you can choose whether to retrieve instance metadata
	// with a signed token header on your request. If you retrieve the IAM role
	// credentials without a token, the version 1.0 role credentials are returned.
	// If you retrieve the IAM role credentials by using a valid signed token, the
	// version 2.0 role credentials are returned.
	//
	// If the state is required, you must send a signed token header with all instance
	// metadata retrieval requests. In this state, retrieving the IAM role credential
	// always returns the version 2.0 credentials. The version 1.0 credentials are
	// not available.
	//
	// Not all instance blueprints in Lightsail support version 2.0 credentials.
	// Use the MetadataNoToken instance metric to track the number of calls to the
	// instance metadata service that are using version 1.0 credentials. For more
	// information, see Viewing instance metrics in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-health-metrics)
	// in the Amazon Lightsail Developer Guide.
	HttpTokens *string `locationName:"httpTokens" type:"string" enum:"HttpTokens"`

	// The state of the metadata option changes.
	//
	// The following states are possible:
	//
	//    * pending - The metadata options are being updated. The instance is not
	//    yet ready to process metadata traffic with the new selection.
	//
	//    * applied - The metadata options have been successfully applied to the
	//    instance.
	State *string `locationName:"state" type:"string" enum:"InstanceMetadataState"`
	// contains filtered or unexported fields
}

The metadata options for the instance.

func (InstanceMetadataOptions) GoString added in v1.44.105 

func (s InstanceMetadataOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceMetadataOptions) SetHttpEndpoint added in v1.44.105 

func (s *InstanceMetadataOptions) SetHttpEndpoint(v string) *InstanceMetadataOptions

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*InstanceMetadataOptions) SetHttpProtocolIpv6 added in v1.44.105 

func (s *InstanceMetadataOptions) SetHttpProtocolIpv6(v string) *InstanceMetadataOptions

SetHttpProtocolIpv6 sets the HttpProtocolIpv6 field's value.

func (*InstanceMetadataOptions) SetHttpPutResponseHopLimit added in v1.44.105 

func (s *InstanceMetadataOptions) SetHttpPutResponseHopLimit(v int64) *InstanceMetadataOptions

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*InstanceMetadataOptions) SetHttpTokens added in v1.44.105 

func (s *InstanceMetadataOptions) SetHttpTokens(v string) *InstanceMetadataOptions

SetHttpTokens sets the HttpTokens field's value.

func (*InstanceMetadataOptions) SetState added in v1.44.105 

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

SetState sets the State field's value.

func (InstanceMetadataOptions) String added in v1.44.105 

func (s InstanceMetadataOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceNetworking) SetMonthlyTransfer 

func (s *InstanceNetworking) SetMonthlyTransfer(v *MonthlyTransfer) *InstanceNetworking

SetMonthlyTransfer sets the MonthlyTransfer field's value.

func (*InstanceNetworking) SetPorts 

func (s *InstanceNetworking) SetPorts(v []*InstancePortInfo) *InstanceNetworking

SetPorts sets the Ports field's value.

func (InstanceNetworking) String 

func (s InstanceNetworking) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstancePortInfo 

type InstancePortInfo struct {

	// The access direction (inbound or outbound).
	//
	// Lightsail currently supports only inbound access direction.
	AccessDirection *string `locationName:"accessDirection" type:"string" enum:"AccessDirection"`

	// The location from which access is allowed. For example, Anywhere (0.0.0.0/0),
	// or Custom if a specific IP address or range of IP addresses is allowed.
	AccessFrom *string `locationName:"accessFrom" type:"string"`

	// The type of access (Public or Private).
	AccessType *string `locationName:"accessType" type:"string" enum:"PortAccessType"`

	// An alias that defines access for a preconfigured range of IP addresses.
	//
	// The only alias currently supported is lightsail-connect, which allows IP
	// addresses of the browser-based RDP/SSH client in the Lightsail console to
	// connect to your instance.
	CidrListAliases []*string `locationName:"cidrListAliases" type:"list"`

	// The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are
	// allowed to connect to an instance through the ports, and the protocol.
	//
	// The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect
	// to an instance.
	//
	// For more information about CIDR block notation, see Classless Inter-Domain
	// Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
	// on Wikipedia.
	Cidrs []*string `locationName:"cidrs" type:"list"`

	// The common name of the port information.
	CommonName *string `locationName:"commonName" type:"string"`

	// The first port in a range of open ports on an instance.
	//
	// Allowed ports:
	//
	//    * TCP and UDP - 0 to 65535
	//
	//    * ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the
	//    fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP
	//    Ping. For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages)
	//    on Wikipedia.
	//
	//    * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128
	//    as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more
	//    information, see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
	FromPort *int64 `locationName:"fromPort" type:"integer"`

	// The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are
	// allowed to connect to an instance through the ports, and the protocol. Only
	// devices with an IPv6 address can connect to an instance through IPv6; otherwise,
	// IPv4 should be used.
	//
	// The cidrs parameter lists the IPv4 addresses that are allowed to connect
	// to an instance.
	//
	// For more information about CIDR block notation, see Classless Inter-Domain
	// Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
	// on Wikipedia.
	Ipv6Cidrs []*string `locationName:"ipv6Cidrs" type:"list"`

	// The IP protocol name.
	//
	// The name can be one of the following:
	//
	//    * tcp - Transmission Control Protocol (TCP) provides reliable, ordered,
	//    and error-checked delivery of streamed data between applications running
	//    on hosts communicating by an IP network. If you have an application that
	//    doesn't require reliable data stream service, use UDP instead.
	//
	//    * all - All transport layer protocol types. For more general information,
	//    see Transport layer (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.
	//
	//    * icmp - Internet Control Message Protocol (ICMP) is used to send error
	//    messages and operational information indicating success or failure when
	//    communicating with an instance. For example, an error is indicated when
	//    an instance could not be reached. When you specify icmp as the protocol,
	//    you must specify the ICMP type using the fromPort parameter, and ICMP
	//    code using the toPort parameter.
	Protocol *string `locationName:"protocol" type:"string" enum:"NetworkProtocol"`

	// The last port in a range of open ports on an instance.
	//
	// Allowed ports:
	//
	//    * TCP and UDP - 0 to 65535
	//
	//    * ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the
	//    fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP
	//    Ping. For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages)
	//    on Wikipedia.
	//
	//    * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128
	//    as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more
	//    information, see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
	ToPort *int64 `locationName:"toPort" type:"integer"`
	// contains filtered or unexported fields
}

Describes information about ports for an Amazon Lightsail instance.

func (InstancePortInfo) GoString 

func (s InstancePortInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCidrListAliases added in v1.30.23 

func (s *InstancePortInfo) SetCidrListAliases(v []*string) *InstancePortInfo

SetCidrListAliases sets the CidrListAliases field's value.

func (*InstancePortInfo) SetCidrs added in v1.30.23 

func (s *InstancePortInfo) SetCidrs(v []*string) *InstancePortInfo

SetCidrs sets the Cidrs 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) SetIpv6Cidrs added in v1.36.25 

func (s *InstancePortInfo) SetIpv6Cidrs(v []*string) *InstancePortInfo

SetIpv6Cidrs sets the Ipv6Cidrs 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstancePortState added in v1.8.26 

type InstancePortState struct {

	// An alias that defines access for a preconfigured range of IP addresses.
	//
	// The only alias currently supported is lightsail-connect, which allows IP
	// addresses of the browser-based RDP/SSH client in the Lightsail console to
	// connect to your instance.
	CidrListAliases []*string `locationName:"cidrListAliases" type:"list"`

	// The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are
	// allowed to connect to an instance through the ports, and the protocol.
	//
	// The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect
	// to an instance.
	//
	// For more information about CIDR block notation, see Classless Inter-Domain
	// Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
	// on Wikipedia.
	Cidrs []*string `locationName:"cidrs" type:"list"`

	// The first port in a range of open ports on an instance.
	//
	// Allowed ports:
	//
	//    * TCP and UDP - 0 to 65535
	//
	//    * ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the
	//    fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP
	//    Ping. For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages)
	//    on Wikipedia.
	//
	//    * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128
	//    as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more
	//    information, see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
	FromPort *int64 `locationName:"fromPort" type:"integer"`

	// The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are
	// allowed to connect to an instance through the ports, and the protocol. Only
	// devices with an IPv6 address can connect to an instance through IPv6; otherwise,
	// IPv4 should be used.
	//
	// The cidrs parameter lists the IPv4 addresses that are allowed to connect
	// to an instance.
	//
	// For more information about CIDR block notation, see Classless Inter-Domain
	// Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
	// on Wikipedia.
	Ipv6Cidrs []*string `locationName:"ipv6Cidrs" type:"list"`

	// The IP protocol name.
	//
	// The name can be one of the following:
	//
	//    * tcp - Transmission Control Protocol (TCP) provides reliable, ordered,
	//    and error-checked delivery of streamed data between applications running
	//    on hosts communicating by an IP network. If you have an application that
	//    doesn't require reliable data stream service, use UDP instead.
	//
	//    * all - All transport layer protocol types. For more general information,
	//    see Transport layer (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.
	//
	//    * icmp - Internet Control Message Protocol (ICMP) is used to send error
	//    messages and operational information indicating success or failure when
	//    communicating with an instance. For example, an error is indicated when
	//    an instance could not be reached. When you specify icmp as the protocol,
	//    you must specify the ICMP type using the fromPort parameter, and ICMP
	//    code using the toPort parameter.
	Protocol *string `locationName:"protocol" type:"string" enum:"NetworkProtocol"`

	// Specifies whether the instance port is open or closed.
	//
	// The port state for Lightsail instances is always open.
	State *string `locationName:"state" type:"string" enum:"PortState"`

	// The last port in a range of open ports on an instance.
	//
	// Allowed ports:
	//
	//    * TCP and UDP - 0 to 65535
	//
	//    * ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the
	//    fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP
	//    Ping. For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages)
	//    on Wikipedia.
	//
	//    * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128
	//    as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more
	//    information, see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
	ToPort *int64 `locationName:"toPort" type:"integer"`
	// contains filtered or unexported fields
}

Describes open ports on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

func (InstancePortState) GoString added in v1.8.26 

func (s InstancePortState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstancePortState) SetCidrListAliases added in v1.30.23 

func (s *InstancePortState) SetCidrListAliases(v []*string) *InstancePortState

SetCidrListAliases sets the CidrListAliases field's value.

func (*InstancePortState) SetCidrs added in v1.30.23 

func (s *InstancePortState) SetCidrs(v []*string) *InstancePortState

SetCidrs sets the Cidrs field's value.

func (*InstancePortState) SetFromPort added in v1.8.26 

func (s *InstancePortState) SetFromPort(v int64) *InstancePortState

SetFromPort sets the FromPort field's value.

func (*InstancePortState) SetIpv6Cidrs added in v1.36.25 

func (s *InstancePortState) SetIpv6Cidrs(v []*string) *InstancePortState

SetIpv6Cidrs sets the Ipv6Cidrs 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// A Boolean value indicating whether the snapshot was created from an automatic
	// snapshot.
	IsFromAutoSnapshot *bool `locationName:"isFromAutoSnapshot" type:"boolean"`

	// 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.
	//
	// This is populated only for disk snapshots, and is null for instance snapshots.
	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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes an instance snapshot.

func (InstanceSnapshot) GoString 

func (s InstanceSnapshot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceSnapshot) SetArn 

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

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) SetIsFromAutoSnapshot added in v1.25.4 

func (s *InstanceSnapshot) SetIsFromAutoSnapshot(v bool) *InstanceSnapshot

SetIsFromAutoSnapshot sets the IsFromAutoSnapshot field's value.

func (*InstanceSnapshot) SetLocation 

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

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InstanceSnapshotInfo added in v1.15.86 

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

func (s InstanceSnapshotInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InstanceSnapshotInfo) SetFromBlueprintId added in v1.15.86 

func (s *InstanceSnapshotInfo) SetFromBlueprintId(v string) *InstanceSnapshotInfo

SetFromBlueprintId sets the FromBlueprintId field's value.

func (*InstanceSnapshotInfo) SetFromBundleId added in v1.15.86 

func (s *InstanceSnapshotInfo) SetFromBundleId(v string) *InstanceSnapshotInfo

SetFromBundleId sets the FromBundleId field's value.

func (*InstanceSnapshotInfo) SetFromDiskInfo added in v1.15.86 

func (s *InstanceSnapshotInfo) SetFromDiskInfo(v []*DiskInfo) *InstanceSnapshotInfo

SetFromDiskInfo sets the FromDiskInfo field's value.

func (InstanceSnapshotInfo) String added in v1.15.86 

func (s InstanceSnapshotInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidInputException added in v1.28.0 

type InvalidInputException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"code" type:"string"`

	Docs *string `locationName:"docs" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	Tip *string `locationName:"tip" type:"string"`
	// contains filtered or unexported fields
}

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

func (*InvalidInputException) Code added in v1.28.0 

func (s *InvalidInputException) Code() string

Code returns the exception type name.

func (*InvalidInputException) Error added in v1.28.0 

func (s *InvalidInputException) Error() string

func (InvalidInputException) GoString added in v1.28.0 

func (s InvalidInputException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidInputException) Message added in v1.28.0 

func (s *InvalidInputException) Message() string

Message returns the exception's message.

func (*InvalidInputException) OrigErr added in v1.28.0 

func (s *InvalidInputException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInputException) RequestID added in v1.28.0 

func (s *InvalidInputException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInputException) StatusCode added in v1.28.0 

func (s *InvalidInputException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidInputException) String added in v1.28.0 

func (s InvalidInputException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IsVpcPeeredInput 

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

func (IsVpcPeeredInput) GoString 

func (s IsVpcPeeredInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (IsVpcPeeredInput) String 

func (s IsVpcPeeredInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes an SSH key pair.

func (KeyPair) GoString 

func (s KeyPair) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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: 

mySession := session.Must(session.NewSession())

// 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) AttachCertificateToDistribution added in v1.33.11 

func (c *Lightsail) AttachCertificateToDistribution(input *AttachCertificateToDistributionInput) (*AttachCertificateToDistributionOutput, error)

AttachCertificateToDistribution API operation for Amazon Lightsail.

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

Use the CreateCertificate action to create a certificate that you can attach to your distribution.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

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 AttachCertificateToDistribution for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/AttachCertificateToDistribution

func (*Lightsail) AttachCertificateToDistributionRequest added in v1.33.11 

func (c *Lightsail) AttachCertificateToDistributionRequest(input *AttachCertificateToDistributionInput) (req *request.Request, output *AttachCertificateToDistributionOutput)

AttachCertificateToDistributionRequest generates a "aws/request.Request" representing the client's request for the AttachCertificateToDistribution 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 AttachCertificateToDistribution for more information on using the AttachCertificateToDistribution 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 AttachCertificateToDistributionRequest method.
req, resp := client.AttachCertificateToDistributionRequest(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/AttachCertificateToDistribution

func (*Lightsail) AttachCertificateToDistributionWithContext added in v1.33.11 

func (c *Lightsail) AttachCertificateToDistributionWithContext(ctx aws.Context, input *AttachCertificateToDistributionInput, opts ...request.Option) (*AttachCertificateToDistributionOutput, error)

AttachCertificateToDistributionWithContext is the same as AttachCertificateToDistribution with the addition of the ability to pass a context and additional request options.

See AttachCertificateToDistribution 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 disk name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 load balancer name. For more information, see the Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 action with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 ports for a specific Amazon Lightsail instance.

The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

func (c *Lightsail) CopySnapshot(input *CopySnapshotInput) (*CopySnapshotOutput, error)

CopySnapshot API operation for Amazon Lightsail.

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

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

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) CreateBucket added in v1.40.0 

func (c *Lightsail) CreateBucket(input *CreateBucketInput) (*CreateBucketOutput, error)

CreateBucket API operation for Amazon Lightsail.

Creates an Amazon Lightsail bucket.

A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail) in the Amazon Lightsail Developer Guide.

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 CreateBucket for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • ServiceException A general service exception.

  • 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/CreateBucket

func (*Lightsail) CreateBucketAccessKey added in v1.40.0 

func (c *Lightsail) CreateBucketAccessKey(input *CreateBucketAccessKeyInput) (*CreateBucketAccessKeyOutput, error)

CreateBucketAccessKey API operation for Amazon Lightsail.

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html) action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

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 CreateBucketAccessKey for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • ServiceException A general service exception.

  • 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/CreateBucketAccessKey

func (*Lightsail) CreateBucketAccessKeyRequest added in v1.40.0 

func (c *Lightsail) CreateBucketAccessKeyRequest(input *CreateBucketAccessKeyInput) (req *request.Request, output *CreateBucketAccessKeyOutput)

CreateBucketAccessKeyRequest generates a "aws/request.Request" representing the client's request for the CreateBucketAccessKey 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 CreateBucketAccessKey for more information on using the CreateBucketAccessKey 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 CreateBucketAccessKeyRequest method.
req, resp := client.CreateBucketAccessKeyRequest(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/CreateBucketAccessKey

func (*Lightsail) CreateBucketAccessKeyWithContext added in v1.40.0 

func (c *Lightsail) CreateBucketAccessKeyWithContext(ctx aws.Context, input *CreateBucketAccessKeyInput, opts ...request.Option) (*CreateBucketAccessKeyOutput, error)

CreateBucketAccessKeyWithContext is the same as CreateBucketAccessKey with the addition of the ability to pass a context and additional request options.

See CreateBucketAccessKey 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) CreateBucketRequest added in v1.40.0 

func (c *Lightsail) CreateBucketRequest(input *CreateBucketInput) (req *request.Request, output *CreateBucketOutput)

CreateBucketRequest generates a "aws/request.Request" representing the client's request for the CreateBucket 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 CreateBucket for more information on using the CreateBucket 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 CreateBucketRequest method.
req, resp := client.CreateBucketRequest(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/CreateBucket

func (*Lightsail) CreateBucketWithContext added in v1.40.0 

func (c *Lightsail) CreateBucketWithContext(ctx aws.Context, input *CreateBucketInput, opts ...request.Option) (*CreateBucketOutput, error)

CreateBucketWithContext is the same as CreateBucket with the addition of the ability to pass a context and additional request options.

See CreateBucket 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) CreateCertificate added in v1.33.11 

func (c *Lightsail) CreateCertificate(input *CreateCertificateInput) (*CreateCertificateOutput, error)

CreateCertificate API operation for Amazon Lightsail.

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.

After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

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 CreateCertificate for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/CreateCertificate

func (*Lightsail) CreateCertificateRequest added in v1.33.11 

func (c *Lightsail) CreateCertificateRequest(input *CreateCertificateInput) (req *request.Request, output *CreateCertificateOutput)

CreateCertificateRequest generates a "aws/request.Request" representing the client's request for the CreateCertificate 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 CreateCertificate for more information on using the CreateCertificate 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 CreateCertificateRequest method.
req, resp := client.CreateCertificateRequest(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/CreateCertificate

func (*Lightsail) CreateCertificateWithContext added in v1.33.11 

func (c *Lightsail) CreateCertificateWithContext(ctx aws.Context, input *CreateCertificateInput, opts ...request.Option) (*CreateCertificateOutput, error)

CreateCertificateWithContext is the same as CreateCertificate with the addition of the ability to pass a context and additional request options.

See CreateCertificate 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.15.86 

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

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

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) CreateContactMethod added in v1.29.12 

func (c *Lightsail) CreateContactMethod(input *CreateContactMethodInput) (*CreateContactMethodOutput, error)

CreateContactMethod API operation for Amazon Lightsail.

Creates an email or SMS text message contact method.

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

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 CreateContactMethod for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/CreateContactMethod

func (*Lightsail) CreateContactMethodRequest added in v1.29.12 

func (c *Lightsail) CreateContactMethodRequest(input *CreateContactMethodInput) (req *request.Request, output *CreateContactMethodOutput)

CreateContactMethodRequest generates a "aws/request.Request" representing the client's request for the CreateContactMethod 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 CreateContactMethod for more information on using the CreateContactMethod 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 CreateContactMethodRequest method.
req, resp := client.CreateContactMethodRequest(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/CreateContactMethod

func (*Lightsail) CreateContactMethodWithContext added in v1.29.12 

func (c *Lightsail) CreateContactMethodWithContext(ctx aws.Context, input *CreateContactMethodInput, opts ...request.Option) (*CreateContactMethodOutput, error)

CreateContactMethodWithContext is the same as CreateContactMethod with the addition of the ability to pass a context and additional request options.

See CreateContactMethod 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) CreateContainerService added in v1.35.27 

func (c *Lightsail) CreateContainerService(input *CreateContainerServiceInput) (*CreateContainerServiceOutput, error)

CreateContainerService API operation for Amazon Lightsail.

Creates an Amazon Lightsail container service.

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

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 CreateContainerService for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/CreateContainerService

func (*Lightsail) CreateContainerServiceDeployment added in v1.35.27 

func (c *Lightsail) CreateContainerServiceDeployment(input *CreateContainerServiceDeploymentInput) (*CreateContainerServiceDeploymentOutput, error)

CreateContainerServiceDeployment API operation for Amazon Lightsail.

Creates a deployment for your Amazon Lightsail container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images) in the Amazon Lightsail Developer Guide.

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 CreateContainerServiceDeployment for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/CreateContainerServiceDeployment

func (*Lightsail) CreateContainerServiceDeploymentRequest added in v1.35.27 

func (c *Lightsail) CreateContainerServiceDeploymentRequest(input *CreateContainerServiceDeploymentInput) (req *request.Request, output *CreateContainerServiceDeploymentOutput)

CreateContainerServiceDeploymentRequest generates a "aws/request.Request" representing the client's request for the CreateContainerServiceDeployment 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 CreateContainerServiceDeployment for more information on using the CreateContainerServiceDeployment 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 CreateContainerServiceDeploymentRequest method.
req, resp := client.CreateContainerServiceDeploymentRequest(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/CreateContainerServiceDeployment

func (*Lightsail) CreateContainerServiceDeploymentWithContext added in v1.35.27 

func (c *Lightsail) CreateContainerServiceDeploymentWithContext(ctx aws.Context, input *CreateContainerServiceDeploymentInput, opts ...request.Option) (*CreateContainerServiceDeploymentOutput, error)

CreateContainerServiceDeploymentWithContext is the same as CreateContainerServiceDeployment with the addition of the ability to pass a context and additional request options.

See CreateContainerServiceDeployment 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) CreateContainerServiceRegistryLogin added in v1.35.27 

func (c *Lightsail) CreateContainerServiceRegistryLogin(input *CreateContainerServiceRegistryLoginInput) (*CreateContainerServiceRegistryLoginOutput, error)

CreateContainerServiceRegistryLogin API operation for Amazon Lightsail.

Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.

You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.

After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.

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

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 CreateContainerServiceRegistryLogin for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/CreateContainerServiceRegistryLogin

func (*Lightsail) CreateContainerServiceRegistryLoginRequest added in v1.35.27 

func (c *Lightsail) CreateContainerServiceRegistryLoginRequest(input *CreateContainerServiceRegistryLoginInput) (req *request.Request, output *CreateContainerServiceRegistryLoginOutput)

CreateContainerServiceRegistryLoginRequest generates a "aws/request.Request" representing the client's request for the CreateContainerServiceRegistryLogin 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 CreateContainerServiceRegistryLogin for more information on using the CreateContainerServiceRegistryLogin 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 CreateContainerServiceRegistryLoginRequest method.
req, resp := client.CreateContainerServiceRegistryLoginRequest(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/CreateContainerServiceRegistryLogin

func (*Lightsail) CreateContainerServiceRegistryLoginWithContext added in v1.35.27 

func (c *Lightsail) CreateContainerServiceRegistryLoginWithContext(ctx aws.Context, input *CreateContainerServiceRegistryLoginInput, opts ...request.Option) (*CreateContainerServiceRegistryLoginOutput, error)

CreateContainerServiceRegistryLoginWithContext is the same as CreateContainerServiceRegistryLogin with the addition of the ability to pass a context and additional request options.

See CreateContainerServiceRegistryLogin 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) CreateContainerServiceRequest added in v1.35.27 

func (c *Lightsail) CreateContainerServiceRequest(input *CreateContainerServiceInput) (req *request.Request, output *CreateContainerServiceOutput)

CreateContainerServiceRequest generates a "aws/request.Request" representing the client's request for the CreateContainerService 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 CreateContainerService for more information on using the CreateContainerService 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 CreateContainerServiceRequest method.
req, resp := client.CreateContainerServiceRequest(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/CreateContainerService

func (*Lightsail) CreateContainerServiceWithContext added in v1.35.27 

func (c *Lightsail) CreateContainerServiceWithContext(ctx aws.Context, input *CreateContainerServiceInput, opts ...request.Option) (*CreateContainerServiceOutput, error)

CreateContainerServiceWithContext is the same as CreateContainerService with the addition of the ability to pass a context and additional request options.

See CreateContainerService 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 an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) CreateDistribution added in v1.33.11 

func (c *Lightsail) CreateDistribution(input *CreateDistributionInput) (*CreateDistributionOutput, error)

CreateDistribution API operation for Amazon Lightsail.

Creates an Amazon Lightsail content delivery network (CDN) distribution.

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

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 CreateDistribution for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/CreateDistribution

func (*Lightsail) CreateDistributionRequest added in v1.33.11 

func (c *Lightsail) CreateDistributionRequest(input *CreateDistributionInput) (req *request.Request, output *CreateDistributionOutput)

CreateDistributionRequest generates a "aws/request.Request" representing the client's request for the CreateDistribution 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 CreateDistribution for more information on using the CreateDistribution 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 CreateDistributionRequest method.
req, resp := client.CreateDistributionRequest(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/CreateDistribution

func (*Lightsail) CreateDistributionWithContext added in v1.33.11 

func (c *Lightsail) CreateDistributionWithContext(ctx aws.Context, input *CreateDistributionInput, opts ...request.Option) (*CreateDistributionOutput, error)

CreateDistributionWithContext is the same as CreateDistribution with the addition of the ability to pass a context and additional request options.

See CreateDistribution 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 instances.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

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

Creates one or more new instances from a manual or automatic snapshot of an instance.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 a custom SSH key pair that you can use with an Amazon Lightsail instance.

Use the DownloadDefaultKeyPair (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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/en_us/articles/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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 an SSL/TLS certificate for an Amazon Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

func (c *Lightsail) CreateRelationalDatabaseFromSnapshot(input *CreateRelationalDatabaseFromSnapshotInput) (*CreateRelationalDatabaseFromSnapshotOutput, error)

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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) DeleteAlarm added in v1.29.12 

func (c *Lightsail) DeleteAlarm(input *DeleteAlarmInput) (*DeleteAlarmOutput, error)

DeleteAlarm API operation for Amazon Lightsail.

Deletes an alarm.

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

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 DeleteAlarm for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteAlarm

func (*Lightsail) DeleteAlarmRequest added in v1.29.12 

func (c *Lightsail) DeleteAlarmRequest(input *DeleteAlarmInput) (req *request.Request, output *DeleteAlarmOutput)

DeleteAlarmRequest generates a "aws/request.Request" representing the client's request for the DeleteAlarm 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 DeleteAlarm for more information on using the DeleteAlarm 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 DeleteAlarmRequest method.
req, resp := client.DeleteAlarmRequest(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/DeleteAlarm

func (*Lightsail) DeleteAlarmWithContext added in v1.29.12 

func (c *Lightsail) DeleteAlarmWithContext(ctx aws.Context, input *DeleteAlarmInput, opts ...request.Option) (*DeleteAlarmOutput, error)

DeleteAlarmWithContext is the same as DeleteAlarm with the addition of the ability to pass a context and additional request options.

See DeleteAlarm 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) DeleteAutoSnapshot added in v1.25.4 

func (c *Lightsail) DeleteAutoSnapshot(input *DeleteAutoSnapshotInput) (*DeleteAutoSnapshotOutput, error)

DeleteAutoSnapshot API operation for Amazon Lightsail.

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

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 DeleteAutoSnapshot for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/DeleteAutoSnapshot

func (*Lightsail) DeleteAutoSnapshotRequest added in v1.25.4 

func (c *Lightsail) DeleteAutoSnapshotRequest(input *DeleteAutoSnapshotInput) (req *request.Request, output *DeleteAutoSnapshotOutput)

DeleteAutoSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteAutoSnapshot 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 DeleteAutoSnapshot for more information on using the DeleteAutoSnapshot 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 DeleteAutoSnapshotRequest method.
req, resp := client.DeleteAutoSnapshotRequest(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/DeleteAutoSnapshot

func (*Lightsail) DeleteAutoSnapshotWithContext added in v1.25.4 

func (c *Lightsail) DeleteAutoSnapshotWithContext(ctx aws.Context, input *DeleteAutoSnapshotInput, opts ...request.Option) (*DeleteAutoSnapshotOutput, error)

DeleteAutoSnapshotWithContext is the same as DeleteAutoSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteAutoSnapshot 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) DeleteBucket added in v1.40.0 

func (c *Lightsail) DeleteBucket(input *DeleteBucketInput) (*DeleteBucketOutput, error)

DeleteBucket API operation for Amazon Lightsail.

Deletes a Amazon Lightsail bucket.

When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services 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 DeleteBucket for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • ServiceException A general service exception.

  • 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/DeleteBucket

func (*Lightsail) DeleteBucketAccessKey added in v1.40.0 

func (c *Lightsail) DeleteBucketAccessKey(input *DeleteBucketAccessKeyInput) (*DeleteBucketAccessKeyOutput, error)

DeleteBucketAccessKey API operation for Amazon Lightsail.

Deletes an access key for the specified Amazon Lightsail bucket.

We recommend that you delete an access key if the secret access key is compromised.

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys) in the Amazon Lightsail Developer Guide.

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 DeleteBucketAccessKey for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • ServiceException A general service exception.

  • 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/DeleteBucketAccessKey

func (*Lightsail) DeleteBucketAccessKeyRequest added in v1.40.0 

func (c *Lightsail) DeleteBucketAccessKeyRequest(input *DeleteBucketAccessKeyInput) (req *request.Request, output *DeleteBucketAccessKeyOutput)

DeleteBucketAccessKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteBucketAccessKey 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 DeleteBucketAccessKey for more information on using the DeleteBucketAccessKey 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 DeleteBucketAccessKeyRequest method.
req, resp := client.DeleteBucketAccessKeyRequest(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/DeleteBucketAccessKey

func (*Lightsail) DeleteBucketAccessKeyWithContext added in v1.40.0 

func (c *Lightsail) DeleteBucketAccessKeyWithContext(ctx aws.Context, input *DeleteBucketAccessKeyInput, opts ...request.Option) (*DeleteBucketAccessKeyOutput, error)

DeleteBucketAccessKeyWithContext is the same as DeleteBucketAccessKey with the addition of the ability to pass a context and additional request options.

See DeleteBucketAccessKey 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) DeleteBucketRequest added in v1.40.0 

func (c *Lightsail) DeleteBucketRequest(input *DeleteBucketInput) (req *request.Request, output *DeleteBucketOutput)

DeleteBucketRequest generates a "aws/request.Request" representing the client's request for the DeleteBucket 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 DeleteBucket for more information on using the DeleteBucket 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 DeleteBucketRequest method.
req, resp := client.DeleteBucketRequest(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/DeleteBucket

func (*Lightsail) DeleteBucketWithContext added in v1.40.0 

func (c *Lightsail) DeleteBucketWithContext(ctx aws.Context, input *DeleteBucketInput, opts ...request.Option) (*DeleteBucketOutput, error)

DeleteBucketWithContext is the same as DeleteBucket with the addition of the ability to pass a context and additional request options.

See DeleteBucket 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) DeleteCertificate added in v1.33.11 

func (c *Lightsail) DeleteCertificate(input *DeleteCertificateInput) (*DeleteCertificateOutput, error)

DeleteCertificate API operation for Amazon Lightsail.

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.

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 DeleteCertificate for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • 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/DeleteCertificate

func (*Lightsail) DeleteCertificateRequest added in v1.33.11 

func (c *Lightsail) DeleteCertificateRequest(input *DeleteCertificateInput) (req *request.Request, output *DeleteCertificateOutput)

DeleteCertificateRequest generates a "aws/request.Request" representing the client's request for the DeleteCertificate 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 DeleteCertificate for more information on using the DeleteCertificate 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 DeleteCertificateRequest method.
req, resp := client.DeleteCertificateRequest(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/DeleteCertificate

func (*Lightsail) DeleteCertificateWithContext added in v1.33.11 

func (c *Lightsail) DeleteCertificateWithContext(ctx aws.Context, input *DeleteCertificateInput, opts ...request.Option) (*DeleteCertificateOutput, error)

DeleteCertificateWithContext is the same as DeleteCertificate with the addition of the ability to pass a context and additional request options.

See DeleteCertificate 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) DeleteContactMethod added in v1.29.12 

func (c *Lightsail) DeleteContactMethod(input *DeleteContactMethodInput) (*DeleteContactMethodOutput, error)

DeleteContactMethod API operation for Amazon Lightsail.

Deletes a contact method.

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

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 DeleteContactMethod for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContactMethod

func (*Lightsail) DeleteContactMethodRequest added in v1.29.12 

func (c *Lightsail) DeleteContactMethodRequest(input *DeleteContactMethodInput) (req *request.Request, output *DeleteContactMethodOutput)

DeleteContactMethodRequest generates a "aws/request.Request" representing the client's request for the DeleteContactMethod 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 DeleteContactMethod for more information on using the DeleteContactMethod 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 DeleteContactMethodRequest method.
req, resp := client.DeleteContactMethodRequest(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/DeleteContactMethod

func (*Lightsail) DeleteContactMethodWithContext added in v1.29.12 

func (c *Lightsail) DeleteContactMethodWithContext(ctx aws.Context, input *DeleteContactMethodInput, opts ...request.Option) (*DeleteContactMethodOutput, error)

DeleteContactMethodWithContext is the same as DeleteContactMethod with the addition of the ability to pass a context and additional request options.

See DeleteContactMethod 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) DeleteContainerImage added in v1.35.27 

func (c *Lightsail) DeleteContainerImage(input *DeleteContainerImageInput) (*DeleteContainerImageOutput, error)

DeleteContainerImage API operation for Amazon Lightsail.

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

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 DeleteContainerImage for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/DeleteContainerImage

func (*Lightsail) DeleteContainerImageRequest added in v1.35.27 

func (c *Lightsail) DeleteContainerImageRequest(input *DeleteContainerImageInput) (req *request.Request, output *DeleteContainerImageOutput)

DeleteContainerImageRequest generates a "aws/request.Request" representing the client's request for the DeleteContainerImage 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 DeleteContainerImage for more information on using the DeleteContainerImage 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 DeleteContainerImageRequest method.
req, resp := client.DeleteContainerImageRequest(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/DeleteContainerImage

func (*Lightsail) DeleteContainerImageWithContext added in v1.35.27 

func (c *Lightsail) DeleteContainerImageWithContext(ctx aws.Context, input *DeleteContainerImageInput, opts ...request.Option) (*DeleteContainerImageOutput, error)

DeleteContainerImageWithContext is the same as DeleteContainerImage with the addition of the ability to pass a context and additional request options.

See DeleteContainerImage 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) DeleteContainerService added in v1.35.27 

func (c *Lightsail) DeleteContainerService(input *DeleteContainerServiceInput) (*DeleteContainerServiceOutput, error)

DeleteContainerService API operation for Amazon Lightsail.

Deletes your Amazon Lightsail container service.

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 DeleteContainerService for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/DeleteContainerService

func (*Lightsail) DeleteContainerServiceRequest added in v1.35.27 

func (c *Lightsail) DeleteContainerServiceRequest(input *DeleteContainerServiceInput) (req *request.Request, output *DeleteContainerServiceOutput)

DeleteContainerServiceRequest generates a "aws/request.Request" representing the client's request for the DeleteContainerService 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 DeleteContainerService for more information on using the DeleteContainerService 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 DeleteContainerServiceRequest method.
req, resp := client.DeleteContainerServiceRequest(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/DeleteContainerService

func (*Lightsail) DeleteContainerServiceWithContext added in v1.35.27 

func (c *Lightsail) DeleteContainerServiceWithContext(ctx aws.Context, input *DeleteContainerServiceInput, opts ...request.Option) (*DeleteContainerServiceOutput, error)

DeleteContainerServiceWithContext is the same as DeleteContainerService with the addition of the ability to pass a context and additional request options.

See DeleteContainerService 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 disk name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 disk snapshot name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) DeleteDistribution added in v1.33.11 

func (c *Lightsail) DeleteDistribution(input *DeleteDistributionInput) (*DeleteDistributionOutput, error)

DeleteDistribution API operation for Amazon Lightsail.

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

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 DeleteDistribution for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/DeleteDistribution

func (*Lightsail) DeleteDistributionRequest added in v1.33.11 

func (c *Lightsail) DeleteDistributionRequest(input *DeleteDistributionInput) (req *request.Request, output *DeleteDistributionOutput)

DeleteDistributionRequest generates a "aws/request.Request" representing the client's request for the DeleteDistribution 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 DeleteDistribution for more information on using the DeleteDistribution 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 DeleteDistributionRequest method.
req, resp := client.DeleteDistributionRequest(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/DeleteDistribution

func (*Lightsail) DeleteDistributionWithContext added in v1.33.11 

func (c *Lightsail) DeleteDistributionWithContext(ctx aws.Context, input *DeleteDistributionInput, opts ...request.Option) (*DeleteDistributionOutput, error)

DeleteDistributionWithContext is the same as DeleteDistribution with the addition of the ability to pass a context and additional request options.

See DeleteDistribution 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 domain name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 domain name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 an Amazon Lightsail instance.

The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 instance snapshot name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 the specified key pair by removing the public key from Amazon Lightsail.

You can delete key pairs that were created using the ImportKeyPair (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html) and CreateKeyPair (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html) actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) API.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.19.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_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.19.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.19.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 load balancer name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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) DetachCertificateFromDistribution added in v1.33.11 

func (c *Lightsail) DetachCertificateFromDistribution(input *DetachCertificateFromDistributionInput) (*DetachCertificateFromDistributionOutput, error)

DetachCertificateFromDistribution API operation for Amazon Lightsail.

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.

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 DetachCertificateFromDistribution for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/DetachCertificateFromDistribution

func (*Lightsail) DetachCertificateFromDistributionRequest added in v1.33.11 

func (c *Lightsail) DetachCertificateFromDistributionRequest(input *DetachCertificateFromDistributionInput) (req *request.Request, output *DetachCertificateFromDistributionOutput)

DetachCertificateFromDistributionRequest generates a "aws/request.Request" representing the client's request for the DetachCertificateFromDistribution 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 DetachCertificateFromDistribution for more information on using the DetachCertificateFromDistribution 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 DetachCertificateFromDistributionRequest method.
req, resp := client.DetachCertificateFromDistributionRequest(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/DetachCertificateFromDistribution

func (*Lightsail) DetachCertificateFromDistributionWithContext added in v1.33.11 

func (c *Lightsail) DetachCertificateFromDistributionWithContext(ctx aws.Context, input *DetachCertificateFromDistributionInput, opts ...request.Option) (*DetachCertificateFromDistributionOutput, error)

DetachCertificateFromDistributionWithContext is the same as DetachCertificateFromDistribution with the addition of the ability to pass a context and additional request options.

See DetachCertificateFromDistribution 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 disk name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 load balancer name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) DisableAddOn added in v1.25.4 

func (c *Lightsail) DisableAddOn(input *DisableAddOnInput) (*DisableAddOnOutput, error)

DisableAddOn API operation for Amazon Lightsail.

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

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 DisableAddOn for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/DisableAddOn

func (*Lightsail) DisableAddOnRequest added in v1.25.4 

func (c *Lightsail) DisableAddOnRequest(input *DisableAddOnInput) (req *request.Request, output *DisableAddOnOutput)

DisableAddOnRequest generates a "aws/request.Request" representing the client's request for the DisableAddOn 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 DisableAddOn for more information on using the DisableAddOn 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 DisableAddOnRequest method.
req, resp := client.DisableAddOnRequest(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/DisableAddOn

func (*Lightsail) DisableAddOnWithContext added in v1.25.4 

func (c *Lightsail) DisableAddOnWithContext(ctx aws.Context, input *DisableAddOnInput, opts ...request.Option) (*DisableAddOnOutput, error)

DisableAddOnWithContext is the same as DisableAddOn with the addition of the ability to pass a context and additional request options.

See DisableAddOn 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 regional Amazon Lightsail default key pair.

This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services 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 DownloadDefaultKeyPair for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) EnableAddOn added in v1.25.4 

func (c *Lightsail) EnableAddOn(input *EnableAddOnInput) (*EnableAddOnOutput, error)

EnableAddOn API operation for Amazon Lightsail.

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

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 EnableAddOn for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/EnableAddOn

func (*Lightsail) EnableAddOnRequest added in v1.25.4 

func (c *Lightsail) EnableAddOnRequest(input *EnableAddOnInput) (req *request.Request, output *EnableAddOnOutput)

EnableAddOnRequest generates a "aws/request.Request" representing the client's request for the EnableAddOn 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 EnableAddOn for more information on using the EnableAddOn 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 EnableAddOnRequest method.
req, resp := client.EnableAddOnRequest(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/EnableAddOn

func (*Lightsail) EnableAddOnWithContext added in v1.25.4 

func (c *Lightsail) EnableAddOnWithContext(ctx aws.Context, input *EnableAddOnInput, opts ...request.Option) (*EnableAddOnOutput, error)

EnableAddOnWithContext is the same as EnableAddOn with the addition of the ability to pass a context and additional request options.

See EnableAddOn 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.15.86 

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 source snapshot name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) GetAlarms added in v1.29.12 

func (c *Lightsail) GetAlarms(input *GetAlarmsInput) (*GetAlarmsOutput, error)

GetAlarms API operation for Amazon Lightsail.

Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

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

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 GetAlarms for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAlarms

func (*Lightsail) GetAlarmsRequest added in v1.29.12 

func (c *Lightsail) GetAlarmsRequest(input *GetAlarmsInput) (req *request.Request, output *GetAlarmsOutput)

GetAlarmsRequest generates a "aws/request.Request" representing the client's request for the GetAlarms 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 GetAlarms for more information on using the GetAlarms 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 GetAlarmsRequest method.
req, resp := client.GetAlarmsRequest(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/GetAlarms

func (*Lightsail) GetAlarmsWithContext added in v1.29.12 

func (c *Lightsail) GetAlarmsWithContext(ctx aws.Context, input *GetAlarmsInput, opts ...request.Option) (*GetAlarmsOutput, error)

GetAlarmsWithContext is the same as GetAlarms with the addition of the ability to pass a context and additional request options.

See GetAlarms 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) GetAutoSnapshots added in v1.25.4 

func (c *Lightsail) GetAutoSnapshots(input *GetAutoSnapshotsInput) (*GetAutoSnapshotsOutput, error)

GetAutoSnapshots API operation for Amazon Lightsail.

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

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 GetAutoSnapshots for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetAutoSnapshots

func (*Lightsail) GetAutoSnapshotsRequest added in v1.25.4 

func (c *Lightsail) GetAutoSnapshotsRequest(input *GetAutoSnapshotsInput) (req *request.Request, output *GetAutoSnapshotsOutput)

GetAutoSnapshotsRequest generates a "aws/request.Request" representing the client's request for the GetAutoSnapshots 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 GetAutoSnapshots for more information on using the GetAutoSnapshots 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 GetAutoSnapshotsRequest method.
req, resp := client.GetAutoSnapshotsRequest(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/GetAutoSnapshots

func (*Lightsail) GetAutoSnapshotsWithContext added in v1.25.4 

func (c *Lightsail) GetAutoSnapshotsWithContext(ctx aws.Context, input *GetAutoSnapshotsInput, opts ...request.Option) (*GetAutoSnapshotsOutput, error)

GetAutoSnapshotsWithContext is the same as GetAutoSnapshots with the addition of the ability to pass a context and additional request options.

See GetAutoSnapshots 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 instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) GetBucketAccessKeys added in v1.40.0 

func (c *Lightsail) GetBucketAccessKeys(input *GetBucketAccessKeysInput) (*GetBucketAccessKeysOutput, error)

GetBucketAccessKeys API operation for Amazon Lightsail.

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) action. If you lose the secret access key, you must create a new access key.

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 GetBucketAccessKeys for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • ServiceException A general service exception.

  • 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/GetBucketAccessKeys

func (*Lightsail) GetBucketAccessKeysRequest added in v1.40.0 

func (c *Lightsail) GetBucketAccessKeysRequest(input *GetBucketAccessKeysInput) (req *request.Request, output *GetBucketAccessKeysOutput)

GetBucketAccessKeysRequest generates a "aws/request.Request" representing the client's request for the GetBucketAccessKeys 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 GetBucketAccessKeys for more information on using the GetBucketAccessKeys 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 GetBucketAccessKeysRequest method.
req, resp := client.GetBucketAccessKeysRequest(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/GetBucketAccessKeys

func (*Lightsail) GetBucketAccessKeysWithContext added in v1.40.0 

func (c *Lightsail) GetBucketAccessKeysWithContext(ctx aws.Context, input *GetBucketAccessKeysInput, opts ...request.Option) (*GetBucketAccessKeysOutput, error)

GetBucketAccessKeysWithContext is the same as GetBucketAccessKeys with the addition of the ability to pass a context and additional request options.

See GetBucketAccessKeys 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) GetBucketBundles added in v1.40.0 

func (c *Lightsail) GetBucketBundles(input *GetBucketBundlesInput) (*GetBucketBundlesOutput, error)

GetBucketBundles API operation for Amazon Lightsail.

Returns the bundles that you can apply to a Amazon Lightsail bucket.

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

Use the UpdateBucketBundle (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) action to update the bundle for a bucket.

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 GetBucketBundles for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • ServiceException A general service exception.

  • 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/GetBucketBundles

func (*Lightsail) GetBucketBundlesRequest added in v1.40.0 

func (c *Lightsail) GetBucketBundlesRequest(input *GetBucketBundlesInput) (req *request.Request, output *GetBucketBundlesOutput)

GetBucketBundlesRequest generates a "aws/request.Request" representing the client's request for the GetBucketBundles 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 GetBucketBundles for more information on using the GetBucketBundles 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 GetBucketBundlesRequest method.
req, resp := client.GetBucketBundlesRequest(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/GetBucketBundles

func (*Lightsail) GetBucketBundlesWithContext added in v1.40.0 

func (c *Lightsail) GetBucketBundlesWithContext(ctx aws.Context, input *GetBucketBundlesInput, opts ...request.Option) (*GetBucketBundlesOutput, error)

GetBucketBundlesWithContext is the same as GetBucketBundles with the addition of the ability to pass a context and additional request options.

See GetBucketBundles 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) GetBucketMetricData added in v1.40.0 

func (c *Lightsail) GetBucketMetricData(input *GetBucketMetricDataInput) (*GetBucketMetricDataOutput, error)

GetBucketMetricData API operation for Amazon Lightsail.

Returns the data points of a specific metric for an Amazon Lightsail bucket.

Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.

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 GetBucketMetricData for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • ServiceException A general service exception.

  • 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/GetBucketMetricData

func (*Lightsail) GetBucketMetricDataRequest added in v1.40.0 

func (c *Lightsail) GetBucketMetricDataRequest(input *GetBucketMetricDataInput) (req *request.Request, output *GetBucketMetricDataOutput)

GetBucketMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetBucketMetricData 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 GetBucketMetricData for more information on using the GetBucketMetricData 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 GetBucketMetricDataRequest method.
req, resp := client.GetBucketMetricDataRequest(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/GetBucketMetricData

func (*Lightsail) GetBucketMetricDataWithContext added in v1.40.0 

func (c *Lightsail) GetBucketMetricDataWithContext(ctx aws.Context, input *GetBucketMetricDataInput, opts ...request.Option) (*GetBucketMetricDataOutput, error)

GetBucketMetricDataWithContext is the same as GetBucketMetricData with the addition of the ability to pass a context and additional request options.

See GetBucketMetricData 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) GetBuckets added in v1.40.0 

func (c *Lightsail) GetBuckets(input *GetBucketsInput) (*GetBucketsOutput, error)

GetBuckets API operation for Amazon Lightsail.

Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.

For more information about buckets, see Buckets in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail) in the Amazon Lightsail Developer Guide.

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 GetBuckets for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • ServiceException A general service exception.

  • 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/GetBuckets

func (*Lightsail) GetBucketsRequest added in v1.40.0 

func (c *Lightsail) GetBucketsRequest(input *GetBucketsInput) (req *request.Request, output *GetBucketsOutput)

GetBucketsRequest generates a "aws/request.Request" representing the client's request for the GetBuckets 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 GetBuckets for more information on using the GetBuckets 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 GetBucketsRequest method.
req, resp := client.GetBucketsRequest(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/GetBuckets

func (*Lightsail) GetBucketsWithContext added in v1.40.0 

func (c *Lightsail) GetBucketsWithContext(ctx aws.Context, input *GetBucketsInput, opts ...request.Option) (*GetBucketsOutput, error)

GetBucketsWithContext is the same as GetBuckets with the addition of the ability to pass a context and additional request options.

See GetBuckets 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 bundles that you can apply to an Amazon Lightsail instance when you create it.

A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.

Bundles are referred to as instance plans in the Lightsail console.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) GetCertificates added in v1.33.11 

func (c *Lightsail) GetCertificates(input *GetCertificatesInput) (*GetCertificatesOutput, error)

GetCertificates API operation for Amazon Lightsail.

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

To get a summary of a certificate, ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

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 GetCertificates for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetCertificates

func (*Lightsail) GetCertificatesRequest added in v1.33.11 

func (c *Lightsail) GetCertificatesRequest(input *GetCertificatesInput) (req *request.Request, output *GetCertificatesOutput)

GetCertificatesRequest generates a "aws/request.Request" representing the client's request for the GetCertificates 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 GetCertificates for more information on using the GetCertificates 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 GetCertificatesRequest method.
req, resp := client.GetCertificatesRequest(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/GetCertificates

func (*Lightsail) GetCertificatesWithContext added in v1.33.11 

func (c *Lightsail) GetCertificatesWithContext(ctx aws.Context, input *GetCertificatesInput, opts ...request.Option) (*GetCertificatesOutput, error)

GetCertificatesWithContext is the same as GetCertificates with the addition of the ability to pass a context and additional request options.

See GetCertificates 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.15.86 

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

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

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) GetContactMethods added in v1.29.12 

func (c *Lightsail) GetContactMethods(input *GetContactMethodsInput) (*GetContactMethodsOutput, error)

GetContactMethods API operation for Amazon Lightsail.

Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.

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

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 GetContactMethods for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetContactMethods

func (*Lightsail) GetContactMethodsRequest added in v1.29.12 

func (c *Lightsail) GetContactMethodsRequest(input *GetContactMethodsInput) (req *request.Request, output *GetContactMethodsOutput)

GetContactMethodsRequest generates a "aws/request.Request" representing the client's request for the GetContactMethods 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 GetContactMethods for more information on using the GetContactMethods 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 GetContactMethodsRequest method.
req, resp := client.GetContactMethodsRequest(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/GetContactMethods

func (*Lightsail) GetContactMethodsWithContext added in v1.29.12 

func (c *Lightsail) GetContactMethodsWithContext(ctx aws.Context, input *GetContactMethodsInput, opts ...request.Option) (*GetContactMethodsOutput, error)

GetContactMethodsWithContext is the same as GetContactMethods with the addition of the ability to pass a context and additional request options.

See GetContactMethods 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) GetContainerAPIMetadata added in v1.35.27 

func (c *Lightsail) GetContainerAPIMetadata(input *GetContainerAPIMetadataInput) (*GetContainerAPIMetadataOutput, error)

GetContainerAPIMetadata API operation for Amazon Lightsail.

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

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 GetContainerAPIMetadata for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetContainerAPIMetadata

func (*Lightsail) GetContainerAPIMetadataRequest added in v1.35.27 

func (c *Lightsail) GetContainerAPIMetadataRequest(input *GetContainerAPIMetadataInput) (req *request.Request, output *GetContainerAPIMetadataOutput)

GetContainerAPIMetadataRequest generates a "aws/request.Request" representing the client's request for the GetContainerAPIMetadata 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 GetContainerAPIMetadata for more information on using the GetContainerAPIMetadata 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 GetContainerAPIMetadataRequest method.
req, resp := client.GetContainerAPIMetadataRequest(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/GetContainerAPIMetadata

func (*Lightsail) GetContainerAPIMetadataWithContext added in v1.35.27 

func (c *Lightsail) GetContainerAPIMetadataWithContext(ctx aws.Context, input *GetContainerAPIMetadataInput, opts ...request.Option) (*GetContainerAPIMetadataOutput, error)

GetContainerAPIMetadataWithContext is the same as GetContainerAPIMetadata with the addition of the ability to pass a context and additional request options.

See GetContainerAPIMetadata 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) GetContainerImages added in v1.35.27 

func (c *Lightsail) GetContainerImages(input *GetContainerImagesInput) (*GetContainerImagesOutput, error)

GetContainerImages API operation for Amazon Lightsail.

Returns the container images that are registered to your Amazon Lightsail container service.

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

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 GetContainerImages for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetContainerImages

func (*Lightsail) GetContainerImagesRequest added in v1.35.27 

func (c *Lightsail) GetContainerImagesRequest(input *GetContainerImagesInput) (req *request.Request, output *GetContainerImagesOutput)

GetContainerImagesRequest generates a "aws/request.Request" representing the client's request for the GetContainerImages 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 GetContainerImages for more information on using the GetContainerImages 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 GetContainerImagesRequest method.
req, resp := client.GetContainerImagesRequest(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/GetContainerImages

func (*Lightsail) GetContainerImagesWithContext added in v1.35.27 

func (c *Lightsail) GetContainerImagesWithContext(ctx aws.Context, input *GetContainerImagesInput, opts ...request.Option) (*GetContainerImagesOutput, error)

GetContainerImagesWithContext is the same as GetContainerImages with the addition of the ability to pass a context and additional request options.

See GetContainerImages 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) GetContainerLog added in v1.35.27 

func (c *Lightsail) GetContainerLog(input *GetContainerLogInput) (*GetContainerLogOutput, error)

GetContainerLog API operation for Amazon Lightsail.

Returns the log events of a container of your Amazon Lightsail container service.

If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the Amazon Web Services General Reference.

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 GetContainerLog for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetContainerLog

func (*Lightsail) GetContainerLogRequest added in v1.35.27 

func (c *Lightsail) GetContainerLogRequest(input *GetContainerLogInput) (req *request.Request, output *GetContainerLogOutput)

GetContainerLogRequest generates a "aws/request.Request" representing the client's request for the GetContainerLog 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 GetContainerLog for more information on using the GetContainerLog 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 GetContainerLogRequest method.
req, resp := client.GetContainerLogRequest(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/GetContainerLog

func (*Lightsail) GetContainerLogWithContext added in v1.35.27 

func (c *Lightsail) GetContainerLogWithContext(ctx aws.Context, input *GetContainerLogInput, opts ...request.Option) (*GetContainerLogOutput, error)

GetContainerLogWithContext is the same as GetContainerLog with the addition of the ability to pass a context and additional request options.

See GetContainerLog 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) GetContainerServiceDeployments added in v1.35.27 

func (c *Lightsail) GetContainerServiceDeployments(input *GetContainerServiceDeploymentsInput) (*GetContainerServiceDeploymentsOutput, error)

GetContainerServiceDeployments API operation for Amazon Lightsail.

Returns the deployments for your Amazon Lightsail container service

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.

A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the Amazon Web Services General Reference.

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 GetContainerServiceDeployments for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetContainerServiceDeployments

func (*Lightsail) GetContainerServiceDeploymentsRequest added in v1.35.27 

func (c *Lightsail) GetContainerServiceDeploymentsRequest(input *GetContainerServiceDeploymentsInput) (req *request.Request, output *GetContainerServiceDeploymentsOutput)

GetContainerServiceDeploymentsRequest generates a "aws/request.Request" representing the client's request for the GetContainerServiceDeployments 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 GetContainerServiceDeployments for more information on using the GetContainerServiceDeployments 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 GetContainerServiceDeploymentsRequest method.
req, resp := client.GetContainerServiceDeploymentsRequest(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/GetContainerServiceDeployments

func (*Lightsail) GetContainerServiceDeploymentsWithContext added in v1.35.27 

func (c *Lightsail) GetContainerServiceDeploymentsWithContext(ctx aws.Context, input *GetContainerServiceDeploymentsInput, opts ...request.Option) (*GetContainerServiceDeploymentsOutput, error)

GetContainerServiceDeploymentsWithContext is the same as GetContainerServiceDeployments with the addition of the ability to pass a context and additional request options.

See GetContainerServiceDeployments 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) GetContainerServiceMetricData added in v1.35.27 

func (c *Lightsail) GetContainerServiceMetricData(input *GetContainerServiceMetricDataInput) (*GetContainerServiceMetricDataOutput, error)

GetContainerServiceMetricData API operation for Amazon Lightsail.

Returns the data points of a specific metric of your Amazon Lightsail container service.

Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

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 GetContainerServiceMetricData for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetContainerServiceMetricData

func (*Lightsail) GetContainerServiceMetricDataRequest added in v1.35.27 

func (c *Lightsail) GetContainerServiceMetricDataRequest(input *GetContainerServiceMetricDataInput) (req *request.Request, output *GetContainerServiceMetricDataOutput)

GetContainerServiceMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetContainerServiceMetricData 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 GetContainerServiceMetricData for more information on using the GetContainerServiceMetricData 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 GetContainerServiceMetricDataRequest method.
req, resp := client.GetContainerServiceMetricDataRequest(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/GetContainerServiceMetricData

func (*Lightsail) GetContainerServiceMetricDataWithContext added in v1.35.27 

func (c *Lightsail) GetContainerServiceMetricDataWithContext(ctx aws.Context, input *GetContainerServiceMetricDataInput, opts ...request.Option) (*GetContainerServiceMetricDataOutput, error)

GetContainerServiceMetricDataWithContext is the same as GetContainerServiceMetricData with the addition of the ability to pass a context and additional request options.

See GetContainerServiceMetricData 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) GetContainerServicePowers added in v1.35.27 

func (c *Lightsail) GetContainerServicePowers(input *GetContainerServicePowersInput) (*GetContainerServicePowersOutput, error)

GetContainerServicePowers API operation for Amazon Lightsail.

Returns the list of powers that can be specified for your Amazon Lightsail container services.

The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.

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 GetContainerServicePowers for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetContainerServicePowers

func (*Lightsail) GetContainerServicePowersRequest added in v1.35.27 

func (c *Lightsail) GetContainerServicePowersRequest(input *GetContainerServicePowersInput) (req *request.Request, output *GetContainerServicePowersOutput)

GetContainerServicePowersRequest generates a "aws/request.Request" representing the client's request for the GetContainerServicePowers 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 GetContainerServicePowers for more information on using the GetContainerServicePowers 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 GetContainerServicePowersRequest method.
req, resp := client.GetContainerServicePowersRequest(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/GetContainerServicePowers

func (*Lightsail) GetContainerServicePowersWithContext added in v1.35.27 

func (c *Lightsail) GetContainerServicePowersWithContext(ctx aws.Context, input *GetContainerServicePowersInput, opts ...request.Option) (*GetContainerServicePowersOutput, error)

GetContainerServicePowersWithContext is the same as GetContainerServicePowers with the addition of the ability to pass a context and additional request options.

See GetContainerServicePowers 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) GetContainerServices added in v1.35.27 

func (c *Lightsail) GetContainerServices(input *GetContainerServicesInput) (*GetContainerServicesOutput, error)

GetContainerServices API operation for Amazon Lightsail.

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

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 GetContainerServices for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetContainerServices

func (*Lightsail) GetContainerServicesRequest added in v1.35.27 

func (c *Lightsail) GetContainerServicesRequest(input *GetContainerServicesInput) (req *request.Request, output *GetContainerServicesOutput)

GetContainerServicesRequest generates a "aws/request.Request" representing the client's request for the GetContainerServices 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 GetContainerServices for more information on using the GetContainerServices 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 GetContainerServicesRequest method.
req, resp := client.GetContainerServicesRequest(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/GetContainerServices

func (*Lightsail) GetContainerServicesWithContext added in v1.35.27 

func (c *Lightsail) GetContainerServicesWithContext(ctx aws.Context, input *GetContainerServicesInput, opts ...request.Option) (*GetContainerServicesOutput, error)

GetContainerServicesWithContext is the same as GetContainerServices with the addition of the ability to pass a context and additional request options.

See GetContainerServices 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) GetDistributionBundles added in v1.33.11 

func (c *Lightsail) GetDistributionBundles(input *GetDistributionBundlesInput) (*GetDistributionBundlesOutput, error)

GetDistributionBundles API operation for Amazon Lightsail.

Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

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 GetDistributionBundles for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetDistributionBundles

func (*Lightsail) GetDistributionBundlesRequest added in v1.33.11 

func (c *Lightsail) GetDistributionBundlesRequest(input *GetDistributionBundlesInput) (req *request.Request, output *GetDistributionBundlesOutput)

GetDistributionBundlesRequest generates a "aws/request.Request" representing the client's request for the GetDistributionBundles 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 GetDistributionBundles for more information on using the GetDistributionBundles 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 GetDistributionBundlesRequest method.
req, resp := client.GetDistributionBundlesRequest(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/GetDistributionBundles

func (*Lightsail) GetDistributionBundlesWithContext added in v1.33.11 

func (c *Lightsail) GetDistributionBundlesWithContext(ctx aws.Context, input *GetDistributionBundlesInput, opts ...request.Option) (*GetDistributionBundlesOutput, error)

GetDistributionBundlesWithContext is the same as GetDistributionBundles with the addition of the ability to pass a context and additional request options.

See GetDistributionBundles 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) GetDistributionLatestCacheReset added in v1.33.11 

func (c *Lightsail) GetDistributionLatestCacheReset(input *GetDistributionLatestCacheResetInput) (*GetDistributionLatestCacheResetOutput, error)

GetDistributionLatestCacheReset API operation for Amazon Lightsail.

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

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 GetDistributionLatestCacheReset for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetDistributionLatestCacheReset

func (*Lightsail) GetDistributionLatestCacheResetRequest added in v1.33.11 

func (c *Lightsail) GetDistributionLatestCacheResetRequest(input *GetDistributionLatestCacheResetInput) (req *request.Request, output *GetDistributionLatestCacheResetOutput)

GetDistributionLatestCacheResetRequest generates a "aws/request.Request" representing the client's request for the GetDistributionLatestCacheReset 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 GetDistributionLatestCacheReset for more information on using the GetDistributionLatestCacheReset 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 GetDistributionLatestCacheResetRequest method.
req, resp := client.GetDistributionLatestCacheResetRequest(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/GetDistributionLatestCacheReset

func (*Lightsail) GetDistributionLatestCacheResetWithContext added in v1.33.11 

func (c *Lightsail) GetDistributionLatestCacheResetWithContext(ctx aws.Context, input *GetDistributionLatestCacheResetInput, opts ...request.Option) (*GetDistributionLatestCacheResetOutput, error)

GetDistributionLatestCacheResetWithContext is the same as GetDistributionLatestCacheReset with the addition of the ability to pass a context and additional request options.

See GetDistributionLatestCacheReset 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) GetDistributionMetricData added in v1.33.11 

func (c *Lightsail) GetDistributionMetricData(input *GetDistributionMetricDataInput) (*GetDistributionMetricDataOutput, error)

GetDistributionMetricData API operation for Amazon Lightsail.

Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

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 GetDistributionMetricData for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetDistributionMetricData

func (*Lightsail) GetDistributionMetricDataRequest added in v1.33.11 

func (c *Lightsail) GetDistributionMetricDataRequest(input *GetDistributionMetricDataInput) (req *request.Request, output *GetDistributionMetricDataOutput)

GetDistributionMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetDistributionMetricData 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 GetDistributionMetricData for more information on using the GetDistributionMetricData 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 GetDistributionMetricDataRequest method.
req, resp := client.GetDistributionMetricDataRequest(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/GetDistributionMetricData

func (*Lightsail) GetDistributionMetricDataWithContext added in v1.33.11 

func (c *Lightsail) GetDistributionMetricDataWithContext(ctx aws.Context, input *GetDistributionMetricDataInput, opts ...request.Option) (*GetDistributionMetricDataOutput, error)

GetDistributionMetricDataWithContext is the same as GetDistributionMetricData with the addition of the ability to pass a context and additional request options.

See GetDistributionMetricData 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) GetDistributions added in v1.33.11 

func (c *Lightsail) GetDistributions(input *GetDistributionsInput) (*GetDistributionsOutput, error)

GetDistributions API operation for Amazon Lightsail.

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

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 GetDistributions for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/GetDistributions

func (*Lightsail) GetDistributionsRequest added in v1.33.11 

func (c *Lightsail) GetDistributionsRequest(input *GetDistributionsInput) (req *request.Request, output *GetDistributionsOutput)

GetDistributionsRequest generates a "aws/request.Request" representing the client's request for the GetDistributions 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 GetDistributions for more information on using the GetDistributions 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 GetDistributionsRequest method.
req, resp := client.GetDistributionsRequest(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/GetDistributions

func (*Lightsail) GetDistributionsWithContext added in v1.33.11 

func (c *Lightsail) GetDistributionsWithContext(ctx aws.Context, input *GetDistributionsInput, opts ...request.Option) (*GetDistributionsOutput, error)

GetDistributionsWithContext is the same as GetDistributions with the addition of the ability to pass a context and additional request options.

See GetDistributions 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

func (c *Lightsail) GetExportSnapshotRecords(input *GetExportSnapshotRecordsInput) (*GetExportSnapshotRecordsOutput, error)

GetExportSnapshotRecords API operation for Amazon Lightsail.

Returns all export snapshot records 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 CreateCloudFormationStack (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateCloudFormationStack.html) action.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 instance name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

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

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

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

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) GetLoadBalancerTlsPolicies added in v1.44.1 

func (c *Lightsail) GetLoadBalancerTlsPolicies(input *GetLoadBalancerTlsPoliciesInput) (*GetLoadBalancerTlsPoliciesOutput, error)

GetLoadBalancerTlsPolicies API operation for Amazon Lightsail.

Returns a list of TLS security policies that you can apply to Lightsail load balancers.

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) in the Amazon Lightsail Developer Guide.

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 GetLoadBalancerTlsPolicies for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsPolicies

func (*Lightsail) GetLoadBalancerTlsPoliciesRequest added in v1.44.1 

func (c *Lightsail) GetLoadBalancerTlsPoliciesRequest(input *GetLoadBalancerTlsPoliciesInput) (req *request.Request, output *GetLoadBalancerTlsPoliciesOutput)

GetLoadBalancerTlsPoliciesRequest generates a "aws/request.Request" representing the client's request for the GetLoadBalancerTlsPolicies 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 GetLoadBalancerTlsPolicies for more information on using the GetLoadBalancerTlsPolicies 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 GetLoadBalancerTlsPoliciesRequest method.
req, resp := client.GetLoadBalancerTlsPoliciesRequest(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/GetLoadBalancerTlsPolicies

func (*Lightsail) GetLoadBalancerTlsPoliciesWithContext added in v1.44.1 

func (c *Lightsail) GetLoadBalancerTlsPoliciesWithContext(ctx aws.Context, input *GetLoadBalancerTlsPoliciesInput, opts ...request.Option) (*GetLoadBalancerTlsPoliciesOutput, error)

GetLoadBalancerTlsPoliciesWithContext is the same as GetLoadBalancerTlsPolicies with the addition of the ability to pass a context and additional request options.

See GetLoadBalancerTlsPolicies 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.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

func (c *Lightsail) GetRelationalDatabaseMasterUserPassword(input *GetRelationalDatabaseMasterUserPasswordInput) (*GetRelationalDatabaseMasterUserPasswordOutput, error)

GetRelationalDatabaseMasterUserPassword API operation for Amazon Lightsail.

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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

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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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 an Amazon Lightsail 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

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

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.

The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

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

Peers 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) PutAlarm added in v1.29.12 

func (c *Lightsail) PutAlarm(input *PutAlarmInput) (*PutAlarmOutput, error)

PutAlarm API operation for Amazon Lightsail.

Creates or updates an alarm, and associates it with the specified metric.

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

When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.

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 PutAlarm for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutAlarm

func (*Lightsail) PutAlarmRequest added in v1.29.12 

func (c *Lightsail) PutAlarmRequest(input *PutAlarmInput) (req *request.Request, output *PutAlarmOutput)

PutAlarmRequest generates a "aws/request.Request" representing the client's request for the PutAlarm 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 PutAlarm for more information on using the PutAlarm 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 PutAlarmRequest method.
req, resp := client.PutAlarmRequest(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/PutAlarm

func (*Lightsail) PutAlarmWithContext added in v1.29.12 

func (c *Lightsail) PutAlarmWithContext(ctx aws.Context, input *PutAlarmInput, opts ...request.Option) (*PutAlarmOutput, error)

PutAlarmWithContext is the same as PutAlarm with the addition of the ability to pass a context and additional request options.

See PutAlarm 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.

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.

The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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 instance name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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) RegisterContainerImage added in v1.35.27 

func (c *Lightsail) RegisterContainerImage(input *RegisterContainerImageInput) (*RegisterContainerImageOutput, error)

RegisterContainerImage API operation for Amazon Lightsail.

Registers a container image to your Amazon Lightsail container service.

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

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 RegisterContainerImage for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/RegisterContainerImage

func (*Lightsail) RegisterContainerImageRequest added in v1.35.27 

func (c *Lightsail) RegisterContainerImageRequest(input *RegisterContainerImageInput) (req *request.Request, output *RegisterContainerImageOutput)

RegisterContainerImageRequest generates a "aws/request.Request" representing the client's request for the RegisterContainerImage 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 RegisterContainerImage for more information on using the RegisterContainerImage 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 RegisterContainerImageRequest method.
req, resp := client.RegisterContainerImageRequest(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/RegisterContainerImage

func (*Lightsail) RegisterContainerImageWithContext added in v1.35.27 

func (c *Lightsail) RegisterContainerImageWithContext(ctx aws.Context, input *RegisterContainerImageInput, opts ...request.Option) (*RegisterContainerImageOutput, error)

RegisterContainerImageWithContext is the same as RegisterContainerImage with the addition of the ability to pass a context and additional request options.

See RegisterContainerImage 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) ResetDistributionCache added in v1.33.11 

func (c *Lightsail) ResetDistributionCache(input *ResetDistributionCacheInput) (*ResetDistributionCacheOutput, error)

ResetDistributionCache API operation for Amazon Lightsail.

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

After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.

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 ResetDistributionCache for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/ResetDistributionCache

func (*Lightsail) ResetDistributionCacheRequest added in v1.33.11 

func (c *Lightsail) ResetDistributionCacheRequest(input *ResetDistributionCacheInput) (req *request.Request, output *ResetDistributionCacheOutput)

ResetDistributionCacheRequest generates a "aws/request.Request" representing the client's request for the ResetDistributionCache 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 ResetDistributionCache for more information on using the ResetDistributionCache 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 ResetDistributionCacheRequest method.
req, resp := client.ResetDistributionCacheRequest(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/ResetDistributionCache

func (*Lightsail) ResetDistributionCacheWithContext added in v1.33.11 

func (c *Lightsail) ResetDistributionCacheWithContext(ctx aws.Context, input *ResetDistributionCacheInput, opts ...request.Option) (*ResetDistributionCacheOutput, error)

ResetDistributionCacheWithContext is the same as ResetDistributionCache with the addition of the ability to pass a context and additional request options.

See ResetDistributionCache 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) SendContactMethodVerification added in v1.29.12 

func (c *Lightsail) SendContactMethodVerification(input *SendContactMethodVerificationInput) (*SendContactMethodVerificationOutput, error)

SendContactMethodVerification API operation for Amazon Lightsail.

Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.

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

A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.

Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.

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 SendContactMethodVerification for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SendContactMethodVerification

func (*Lightsail) SendContactMethodVerificationRequest added in v1.29.12 

func (c *Lightsail) SendContactMethodVerificationRequest(input *SendContactMethodVerificationInput) (req *request.Request, output *SendContactMethodVerificationOutput)

SendContactMethodVerificationRequest generates a "aws/request.Request" representing the client's request for the SendContactMethodVerification 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 SendContactMethodVerification for more information on using the SendContactMethodVerification 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 SendContactMethodVerificationRequest method.
req, resp := client.SendContactMethodVerificationRequest(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/SendContactMethodVerification

func (*Lightsail) SendContactMethodVerificationWithContext added in v1.29.12 

func (c *Lightsail) SendContactMethodVerificationWithContext(ctx aws.Context, input *SendContactMethodVerificationInput, opts ...request.Option) (*SendContactMethodVerificationOutput, error)

SendContactMethodVerificationWithContext is the same as SendContactMethodVerification with the addition of the ability to pass a context and additional request options.

See SendContactMethodVerification 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) SetIpAddressType added in v1.36.25 

func (c *Lightsail) SetIpAddressType(input *SetIpAddressTypeInput) (*SetIpAddressTypeOutput, error)

SetIpAddressType API operation for Amazon Lightsail.

Sets the IP address type for an Amazon Lightsail resource.

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.

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 SetIpAddressType for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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/SetIpAddressType

func (*Lightsail) SetIpAddressTypeRequest added in v1.36.25 

func (c *Lightsail) SetIpAddressTypeRequest(input *SetIpAddressTypeInput) (req *request.Request, output *SetIpAddressTypeOutput)

SetIpAddressTypeRequest generates a "aws/request.Request" representing the client's request for the SetIpAddressType 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 SetIpAddressType for more information on using the SetIpAddressType 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 SetIpAddressTypeRequest method.
req, resp := client.SetIpAddressTypeRequest(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/SetIpAddressType

func (*Lightsail) SetIpAddressTypeWithContext added in v1.36.25 

func (c *Lightsail) SetIpAddressTypeWithContext(ctx aws.Context, input *SetIpAddressTypeInput, opts ...request.Option) (*SetIpAddressTypeOutput, error)

SetIpAddressTypeWithContext is the same as SetIpAddressType with the addition of the ability to pass a context and additional request options.

See SetIpAddressType 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) SetResourceAccessForBucket added in v1.40.0 

func (c *Lightsail) SetResourceAccessForBucket(input *SetResourceAccessForBucketInput) (*SetResourceAccessForBucketOutput, error)

SetResourceAccessForBucket API operation for Amazon Lightsail.

Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services 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 SetResourceAccessForBucket for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • ServiceException A general service exception.

  • 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/SetResourceAccessForBucket

func (*Lightsail) SetResourceAccessForBucketRequest added in v1.40.0 

func (c *Lightsail) SetResourceAccessForBucketRequest(input *SetResourceAccessForBucketInput) (req *request.Request, output *SetResourceAccessForBucketOutput)

SetResourceAccessForBucketRequest generates a "aws/request.Request" representing the client's request for the SetResourceAccessForBucket 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 SetResourceAccessForBucket for more information on using the SetResourceAccessForBucket 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 SetResourceAccessForBucketRequest method.
req, resp := client.SetResourceAccessForBucketRequest(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/SetResourceAccessForBucket

func (*Lightsail) SetResourceAccessForBucketWithContext added in v1.40.0 

func (c *Lightsail) SetResourceAccessForBucketWithContext(ctx aws.Context, input *SetResourceAccessForBucketInput, opts ...request.Option) (*SetResourceAccessForBucketOutput, error)

SetResourceAccessForBucketWithContext is the same as SetResourceAccessForBucket with the addition of the ability to pass a context and additional request options.

See SetResourceAccessForBucket 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip).

The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip).

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).

The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

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

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) TestAlarm added in v1.29.12 

func (c *Lightsail) TestAlarm(input *TestAlarmInput) (*TestAlarmOutput, error)

TestAlarm API operation for Amazon Lightsail.

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

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

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 TestAlarm for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TestAlarm

func (*Lightsail) TestAlarmRequest added in v1.29.12 

func (c *Lightsail) TestAlarmRequest(input *TestAlarmInput) (req *request.Request, output *TestAlarmOutput)

TestAlarmRequest generates a "aws/request.Request" representing the client's request for the TestAlarm 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 TestAlarm for more information on using the TestAlarm 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 TestAlarmRequest method.
req, resp := client.TestAlarmRequest(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/TestAlarm

func (*Lightsail) TestAlarmWithContext added in v1.29.12 

func (c *Lightsail) TestAlarmWithContext(ctx aws.Context, input *TestAlarmInput, opts ...request.Option) (*TestAlarmOutput, error)

TestAlarmWithContext is the same as TestAlarm with the addition of the ability to pass a context and additional request options.

See TestAlarm 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.

Unpeers 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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

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 resource name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.86 

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

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) UpdateBucket added in v1.40.0 

func (c *Lightsail) UpdateBucket(input *UpdateBucketInput) (*UpdateBucketOutput, error)

UpdateBucket API operation for Amazon Lightsail.

Updates an existing Amazon Lightsail bucket.

Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.

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 UpdateBucket for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • ServiceException A general service exception.

  • 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/UpdateBucket

func (*Lightsail) UpdateBucketBundle added in v1.40.0 

func (c *Lightsail) UpdateBucketBundle(input *UpdateBucketBundleInput) (*UpdateBucketBundleOutput, error)

UpdateBucketBundle API operation for Amazon Lightsail.

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html) action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle.

Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.

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 UpdateBucketBundle for usage and error information.

Returned Error Types:

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • ServiceException A general service exception.

  • 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/UpdateBucketBundle

func (*Lightsail) UpdateBucketBundleRequest added in v1.40.0 

func (c *Lightsail) UpdateBucketBundleRequest(input *UpdateBucketBundleInput) (req *request.Request, output *UpdateBucketBundleOutput)

UpdateBucketBundleRequest generates a "aws/request.Request" representing the client's request for the UpdateBucketBundle 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 UpdateBucketBundle for more information on using the UpdateBucketBundle 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 UpdateBucketBundleRequest method.
req, resp := client.UpdateBucketBundleRequest(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/UpdateBucketBundle

func (*Lightsail) UpdateBucketBundleWithContext added in v1.40.0 

func (c *Lightsail) UpdateBucketBundleWithContext(ctx aws.Context, input *UpdateBucketBundleInput, opts ...request.Option) (*UpdateBucketBundleOutput, error)

UpdateBucketBundleWithContext is the same as UpdateBucketBundle with the addition of the ability to pass a context and additional request options.

See UpdateBucketBundle 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) UpdateBucketRequest added in v1.40.0 

func (c *Lightsail) UpdateBucketRequest(input *UpdateBucketInput) (req *request.Request, output *UpdateBucketOutput)

UpdateBucketRequest generates a "aws/request.Request" representing the client's request for the UpdateBucket 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 UpdateBucket for more information on using the UpdateBucket 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 UpdateBucketRequest method.
req, resp := client.UpdateBucketRequest(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/UpdateBucket

func (*Lightsail) UpdateBucketWithContext added in v1.40.0 

func (c *Lightsail) UpdateBucketWithContext(ctx aws.Context, input *UpdateBucketInput, opts ...request.Option) (*UpdateBucketOutput, error)

UpdateBucketWithContext is the same as UpdateBucket with the addition of the ability to pass a context and additional request options.

See UpdateBucket 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) UpdateContainerService added in v1.35.27 

func (c *Lightsail) UpdateContainerService(input *UpdateContainerServiceInput) (*UpdateContainerServiceOutput, error)

UpdateContainerService API operation for Amazon Lightsail.

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

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 UpdateContainerService for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/UpdateContainerService

func (*Lightsail) UpdateContainerServiceRequest added in v1.35.27 

func (c *Lightsail) UpdateContainerServiceRequest(input *UpdateContainerServiceInput) (req *request.Request, output *UpdateContainerServiceOutput)

UpdateContainerServiceRequest generates a "aws/request.Request" representing the client's request for the UpdateContainerService 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 UpdateContainerService for more information on using the UpdateContainerService 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 UpdateContainerServiceRequest method.
req, resp := client.UpdateContainerServiceRequest(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/UpdateContainerService

func (*Lightsail) UpdateContainerServiceWithContext added in v1.35.27 

func (c *Lightsail) UpdateContainerServiceWithContext(ctx aws.Context, input *UpdateContainerServiceInput, opts ...request.Option) (*UpdateContainerServiceOutput, error)

UpdateContainerServiceWithContext is the same as UpdateContainerService with the addition of the ability to pass a context and additional request options.

See UpdateContainerService 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) UpdateDistribution added in v1.33.11 

func (c *Lightsail) UpdateDistribution(input *UpdateDistributionInput) (*UpdateDistributionOutput, error)

UpdateDistribution API operation for Amazon Lightsail.

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

Use this action to update the configuration of your existing distribution.

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 UpdateDistribution for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/UpdateDistribution

func (*Lightsail) UpdateDistributionBundle added in v1.33.11 

func (c *Lightsail) UpdateDistributionBundle(input *UpdateDistributionBundleInput) (*UpdateDistributionBundleOutput, error)

UpdateDistributionBundle API operation for Amazon Lightsail.

Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.

You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.

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 UpdateDistributionBundle for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • 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/UpdateDistributionBundle

func (*Lightsail) UpdateDistributionBundleRequest added in v1.33.11 

func (c *Lightsail) UpdateDistributionBundleRequest(input *UpdateDistributionBundleInput) (req *request.Request, output *UpdateDistributionBundleOutput)

UpdateDistributionBundleRequest generates a "aws/request.Request" representing the client's request for the UpdateDistributionBundle 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 UpdateDistributionBundle for more information on using the UpdateDistributionBundle 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 UpdateDistributionBundleRequest method.
req, resp := client.UpdateDistributionBundleRequest(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/UpdateDistributionBundle

func (*Lightsail) UpdateDistributionBundleWithContext added in v1.33.11 

func (c *Lightsail) UpdateDistributionBundleWithContext(ctx aws.Context, input *UpdateDistributionBundleInput, opts ...request.Option) (*UpdateDistributionBundleOutput, error)

UpdateDistributionBundleWithContext is the same as UpdateDistributionBundle with the addition of the ability to pass a context and additional request options.

See UpdateDistributionBundle 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) UpdateDistributionRequest added in v1.33.11 

func (c *Lightsail) UpdateDistributionRequest(input *UpdateDistributionInput) (req *request.Request, output *UpdateDistributionOutput)

UpdateDistributionRequest generates a "aws/request.Request" representing the client's request for the UpdateDistribution 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 UpdateDistribution for more information on using the UpdateDistribution 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 UpdateDistributionRequest method.
req, resp := client.UpdateDistributionRequest(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/UpdateDistribution

func (*Lightsail) UpdateDistributionWithContext added in v1.33.11 

func (c *Lightsail) UpdateDistributionWithContext(ctx aws.Context, input *UpdateDistributionInput, opts ...request.Option) (*UpdateDistributionOutput, error)

UpdateDistributionWithContext is the same as UpdateDistribution with the addition of the ability to pass a context and additional request options.

See UpdateDistribution 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 domain name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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) UpdateInstanceMetadataOptions added in v1.44.105 

func (c *Lightsail) UpdateInstanceMetadataOptions(input *UpdateInstanceMetadataOptionsInput) (*UpdateInstanceMetadataOptionsOutput, error)

UpdateInstanceMetadataOptions API operation for Amazon Lightsail.

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance or GetInstances API operation initially responds with a state of pending. After the parameter modifications are successfully applied, the state changes to applied in subsequent GetInstance or GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-instance-metadata-service) in the Amazon Lightsail Developer Guide.

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 UpdateInstanceMetadataOptions for usage and error information.

Returned Error Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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/UpdateInstanceMetadataOptions

func (*Lightsail) UpdateInstanceMetadataOptionsRequest added in v1.44.105 

func (c *Lightsail) UpdateInstanceMetadataOptionsRequest(input *UpdateInstanceMetadataOptionsInput) (req *request.Request, output *UpdateInstanceMetadataOptionsOutput)

UpdateInstanceMetadataOptionsRequest generates a "aws/request.Request" representing the client's request for the UpdateInstanceMetadataOptions 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 UpdateInstanceMetadataOptions for more information on using the UpdateInstanceMetadataOptions 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 UpdateInstanceMetadataOptionsRequest method.
req, resp := client.UpdateInstanceMetadataOptionsRequest(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/UpdateInstanceMetadataOptions

func (*Lightsail) UpdateInstanceMetadataOptionsWithContext added in v1.44.105 

func (c *Lightsail) UpdateInstanceMetadataOptionsWithContext(ctx aws.Context, input *UpdateInstanceMetadataOptionsInput, opts ...request.Option) (*UpdateInstanceMetadataOptionsOutput, error)

UpdateInstanceMetadataOptionsWithContext is the same as UpdateInstanceMetadataOptions with the addition of the ability to pass a context and additional request options.

See UpdateInstanceMetadataOptions 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 load balancer name. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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 parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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 Types:

  • ServiceException A general service exception.

  • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

    Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

  • NotFoundException Lightsail throws this exception when it cannot find a resource.

  • OperationFailureException Lightsail throws this exception when an operation fails to execute.

  • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

  • AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.

  • 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.15.56 

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

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

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

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 LightsailDistribution added in v1.33.11 

type LightsailDistribution struct {

	// Indicates whether the bundle that is currently applied to your distribution,
	// specified using the distributionName parameter, can be changed to another
	// bundle.
	//
	// Use the UpdateDistributionBundle action to change your distribution's bundle.
	AbleToUpdateBundle *bool `locationName:"ableToUpdateBundle" type:"boolean"`

	// The alternate domain names of the distribution.
	AlternativeDomainNames []*string `locationName:"alternativeDomainNames" type:"list"`

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

	// The ID of the bundle currently applied to the distribution.
	BundleId *string `locationName:"bundleId" type:"string"`

	// An object that describes the cache behavior settings of the distribution.
	CacheBehaviorSettings *CacheSettings `locationName:"cacheBehaviorSettings" type:"structure"`

	// An array of objects that describe the per-path cache behavior of the distribution.
	CacheBehaviors []*CacheBehaviorPerPath `locationName:"cacheBehaviors" type:"list"`

	// The name of the SSL/TLS certificate attached to the distribution, if any.
	CertificateName *string `locationName:"certificateName" type:"string"`

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

	// An object that describes the default cache behavior of the distribution.
	DefaultCacheBehavior *CacheBehavior `locationName:"defaultCacheBehavior" type:"structure"`

	// The domain name of the distribution.
	DomainName *string `locationName:"domainName" type:"string"`

	// The IP address type of the distribution.
	//
	// The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	IpAddressType *string `locationName:"ipAddressType" type:"string" enum:"IpAddressType"`

	// Indicates whether the distribution is enabled.
	IsEnabled *bool `locationName:"isEnabled" type:"boolean"`

	// An object that describes the location of the distribution, such as the Amazon
	// Web Services Region and Availability Zone.
	//
	// Lightsail distributions are global resources that can reference an origin
	// in any Amazon Web Services Region, and distribute its content globally. However,
	// all distributions are located in the us-east-1 Region.
	Location *ResourceLocation `locationName:"location" type:"structure"`

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

	// An object that describes the origin resource of the distribution, such as
	// a Lightsail instance, bucket, or load balancer.
	//
	// The distribution pulls, caches, and serves content from the origin.
	Origin *Origin `locationName:"origin" type:"structure"`

	// The public DNS of the origin.
	OriginPublicDNS *string `locationName:"originPublicDNS" type:"string"`

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

	// The status of the distribution.
	Status *string `locationName:"status" type:"string"`

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

	// The tag keys and optional values for the resource. For more information about
	// tags in Lightsail, see the Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes an Amazon Lightsail content delivery network (CDN) distribution.

func (LightsailDistribution) GoString added in v1.33.11 

func (s LightsailDistribution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LightsailDistribution) SetAbleToUpdateBundle added in v1.33.11 

func (s *LightsailDistribution) SetAbleToUpdateBundle(v bool) *LightsailDistribution

SetAbleToUpdateBundle sets the AbleToUpdateBundle field's value.

func (*LightsailDistribution) SetAlternativeDomainNames added in v1.33.11 

func (s *LightsailDistribution) SetAlternativeDomainNames(v []*string) *LightsailDistribution

SetAlternativeDomainNames sets the AlternativeDomainNames field's value.

func (*LightsailDistribution) SetArn added in v1.33.11 

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

SetArn sets the Arn field's value.

func (*LightsailDistribution) SetBundleId added in v1.33.11 

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

SetBundleId sets the BundleId field's value.

func (*LightsailDistribution) SetCacheBehaviorSettings added in v1.33.11 

func (s *LightsailDistribution) SetCacheBehaviorSettings(v *CacheSettings) *LightsailDistribution

SetCacheBehaviorSettings sets the CacheBehaviorSettings field's value.

func (*LightsailDistribution) SetCacheBehaviors added in v1.33.11 

func (s *LightsailDistribution) SetCacheBehaviors(v []*CacheBehaviorPerPath) *LightsailDistribution

SetCacheBehaviors sets the CacheBehaviors field's value.

func (*LightsailDistribution) SetCertificateName added in v1.33.11 

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

SetCertificateName sets the CertificateName field's value.

func (*LightsailDistribution) SetCreatedAt added in v1.33.11 

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

SetCreatedAt sets the CreatedAt field's value.

func (*LightsailDistribution) SetDefaultCacheBehavior added in v1.33.11 

func (s *LightsailDistribution) SetDefaultCacheBehavior(v *CacheBehavior) *LightsailDistribution

SetDefaultCacheBehavior sets the DefaultCacheBehavior field's value.

func (*LightsailDistribution) SetDomainName added in v1.33.11 

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

SetDomainName sets the DomainName field's value.

func (*LightsailDistribution) SetIpAddressType added in v1.36.25 

func (s *LightsailDistribution) SetIpAddressType(v string) *LightsailDistribution

SetIpAddressType sets the IpAddressType field's value.

func (*LightsailDistribution) SetIsEnabled added in v1.33.11 

func (s *LightsailDistribution) SetIsEnabled(v bool) *LightsailDistribution

SetIsEnabled sets the IsEnabled field's value.

func (*LightsailDistribution) SetLocation added in v1.33.11 

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

SetLocation sets the Location field's value.

func (*LightsailDistribution) SetName added in v1.33.11 

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

SetName sets the Name field's value.

func (*LightsailDistribution) SetOrigin added in v1.33.11 

func (s *LightsailDistribution) SetOrigin(v *Origin) *LightsailDistribution

SetOrigin sets the Origin field's value.

func (*LightsailDistribution) SetOriginPublicDNS added in v1.33.11 

func (s *LightsailDistribution) SetOriginPublicDNS(v string) *LightsailDistribution

SetOriginPublicDNS sets the OriginPublicDNS field's value.

func (*LightsailDistribution) SetResourceType added in v1.33.11 

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

SetResourceType sets the ResourceType field's value.

func (*LightsailDistribution) SetStatus added in v1.33.11 

func (s *LightsailDistribution) SetStatus(v string) *LightsailDistribution

SetStatus sets the Status field's value.

func (*LightsailDistribution) SetSupportCode added in v1.33.11 

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

SetSupportCode sets the SupportCode field's value.

func (*LightsailDistribution) SetTags added in v1.33.11 

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

SetTags sets the Tags field's value.

func (LightsailDistribution) String added in v1.33.11 

func (s LightsailDistribution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

	// A Boolean value that indicates whether HTTPS redirection is enabled for the
	// load balancer.
	HttpsRedirectionEnabled *bool `locationName:"httpsRedirectionEnabled" type:"boolean"`

	// 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 IP address type of the load balancer.
	//
	// The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	IpAddressType *string `locationName:"ipAddressType" type:"string" enum:"IpAddressType"`

	// 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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"`

	// The name of the TLS security policy for the load balancer.
	TlsPolicyName *string `locationName:"tlsPolicyName" type:"string"`
	// contains filtered or unexported fields
}

Describes a load balancer.

func (LoadBalancer) GoString added in v1.12.37 

func (s LoadBalancer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetHttpsRedirectionEnabled added in v1.44.1 

func (s *LoadBalancer) SetHttpsRedirectionEnabled(v bool) *LoadBalancer

SetHttpsRedirectionEnabled sets the HttpsRedirectionEnabled 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) SetIpAddressType added in v1.36.25 

func (s *LoadBalancer) SetIpAddressType(v string) *LoadBalancer

SetIpAddressType sets the IpAddressType 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.15.86 

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) SetTlsPolicyName added in v1.44.1 

func (s *LoadBalancer) SetTlsPolicyName(v string) *LoadBalancer

SetTlsPolicyName sets the TlsPolicyName field's value.

func (LoadBalancer) String added in v1.12.37 

func (s LoadBalancer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 validation failure reason, if any, of the certificate.
	//
	// The following failure reasons are possible:
	//
	//    * NO_AVAILABLE_CONTACTS - This failure applies to email validation, which
	//    is not available for Lightsail certificates.
	//
	//    * ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information
	//    to process this certificate request. This can happen as a fraud-protection
	//    measure, such as when the domain ranks within the Alexa top 1000 websites.
	//    To provide the required information, use the AWS Support Center (https://console.aws.amazon.com/support/home)
	//    to contact AWS Support. You cannot request a certificate for Amazon-owned
	//    domain names such as those ending in amazonaws.com, cloudfront.net, or
	//    elasticbeanstalk.com.
	//
	//    * DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate
	//    request was reported as an unsafe domain by VirusTotal (https://www.virustotal.com/gui/home/url).
	//    To correct the problem, search for your domain name on the VirusTotal
	//    (https://www.virustotal.com/gui/home/url) website. If your domain is reported
	//    as suspicious, see Google Help for Hacked Websites (https://developers.google.com/web/fundamentals/security/hacked)
	//    to learn what you can do. If you believe that the result is a false positive,
	//    notify the organization that is reporting the domain. VirusTotal is an
	//    aggregate of several antivirus and URL scanners and cannot remove your
	//    domain from a block list itself. After you correct the problem and the
	//    VirusTotal registry has been updated, request a new certificate. If you
	//    see this error and your domain is not included in the VirusTotal list,
	//    visit the AWS Support Center (https://console.aws.amazon.com/support/home)
	//    and create a case.
	//
	//    * INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate
	//    request is not valid. Typically, this is because a domain name in the
	//    request is not a valid top-level domain. Try to request a certificate
	//    again, correcting any spelling errors or typos that were in the failed
	//    request, and ensure that all domain names in the request are for valid
	//    top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain
	//    because invalidpublicdomain is not a valid top-level domain.
	//
	//    * OTHER - Typically, this failure occurs when there is a typographical
	//    error in one or more of the domain names in the certificate request. Try
	//    to request a certificate again, correcting any spelling errors or typos
	//    that were in the failed request.
	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 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 Amazon Web Services 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 that describes the status of the certificate renewal managed by
	// Lightsail.
	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. This value is present only when the
	// certificate status is REVOKED.
	RevocationReason *string `locationName:"revocationReason" type:"string" enum:"LoadBalancerTlsCertificateRevocationReason"`

	// The timestamp when the certificate was revoked. This value is present only
	// when the certificate status is 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 validation 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"`

	// An array of strings that specify the alternate domains (e.g., example2.com)
	// and subdomains (e.g., blog.example.com) for the certificate.
	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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerTlsCertificate) SetArn added in v1.12.37 

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

SetArn sets the Arn field's value.

func (*LoadBalancerTlsCertificate) SetCreatedAt added in v1.12.37 

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

SetCreatedAt sets the CreatedAt field's value.

func (*LoadBalancerTlsCertificate) SetDomainName added in v1.12.37 

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

SetDomainName sets the DomainName field's value.

func (*LoadBalancerTlsCertificate) SetDomainValidationRecords added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetDomainValidationRecords(v []*LoadBalancerTlsCertificateDomainValidationRecord) *LoadBalancerTlsCertificate

SetDomainValidationRecords sets the DomainValidationRecords field's value.

func (*LoadBalancerTlsCertificate) SetFailureReason added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetFailureReason(v string) *LoadBalancerTlsCertificate

SetFailureReason sets the FailureReason field's value.

func (*LoadBalancerTlsCertificate) SetIsAttached added in v1.12.37 

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

SetIsAttached sets the IsAttached field's value.

func (*LoadBalancerTlsCertificate) SetIssuedAt added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetIssuedAt(v time.Time) *LoadBalancerTlsCertificate

SetIssuedAt sets the IssuedAt field's value.

func (*LoadBalancerTlsCertificate) SetIssuer added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetIssuer(v string) *LoadBalancerTlsCertificate

SetIssuer sets the Issuer field's value.

func (*LoadBalancerTlsCertificate) SetKeyAlgorithm added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetKeyAlgorithm(v string) *LoadBalancerTlsCertificate

SetKeyAlgorithm sets the KeyAlgorithm field's value.

func (*LoadBalancerTlsCertificate) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (*LoadBalancerTlsCertificate) SetLocation added in v1.12.37 

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

SetLocation sets the Location field's value.

func (*LoadBalancerTlsCertificate) SetName added in v1.12.37 

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

SetName sets the Name field's value.

func (*LoadBalancerTlsCertificate) SetNotAfter added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetNotAfter(v time.Time) *LoadBalancerTlsCertificate

SetNotAfter sets the NotAfter field's value.

func (*LoadBalancerTlsCertificate) SetNotBefore added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetNotBefore(v time.Time) *LoadBalancerTlsCertificate

SetNotBefore sets the NotBefore field's value.

func (*LoadBalancerTlsCertificate) SetRenewalSummary added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetRenewalSummary(v *LoadBalancerTlsCertificateRenewalSummary) *LoadBalancerTlsCertificate

SetRenewalSummary sets the RenewalSummary field's value.

func (*LoadBalancerTlsCertificate) SetResourceType added in v1.12.37 

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

SetResourceType sets the ResourceType field's value.

func (*LoadBalancerTlsCertificate) SetRevocationReason added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetRevocationReason(v string) *LoadBalancerTlsCertificate

SetRevocationReason sets the RevocationReason field's value.

func (*LoadBalancerTlsCertificate) SetRevokedAt added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetRevokedAt(v time.Time) *LoadBalancerTlsCertificate

SetRevokedAt sets the RevokedAt field's value.

func (*LoadBalancerTlsCertificate) SetSerial added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetSerial(v string) *LoadBalancerTlsCertificate

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 

func (s *LoadBalancerTlsCertificate) SetStatus(v string) *LoadBalancerTlsCertificate

SetStatus sets the Status field's value.

func (*LoadBalancerTlsCertificate) SetSubject added in v1.12.37 

func (s *LoadBalancerTlsCertificate) SetSubject(v string) *LoadBalancerTlsCertificate

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 

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

SetSupportCode sets the SupportCode field's value.

func (*LoadBalancerTlsCertificate) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (LoadBalancerTlsCertificate) String added in v1.12.37 

func (s LoadBalancerTlsCertificate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoadBalancerTlsCertificateDnsRecordCreationState added in v1.44.133 

type LoadBalancerTlsCertificateDnsRecordCreationState struct {

	// The status code for the automated DNS record creation.
	//
	// Following are the possible values:
	//
	//    * SUCCEEDED - The validation records were successfully added.
	//
	//    * STARTED - The automatic DNS record creation has started.
	//
	//    * FAILED - The validation record addition failed.
	Code *string `locationName:"code" type:"string" enum:"LoadBalancerTlsCertificateDnsRecordCreationStateCode"`

	// The message that describes the reason for the status code.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

func (LoadBalancerTlsCertificateDnsRecordCreationState) GoString added in v1.44.133 

func (s LoadBalancerTlsCertificateDnsRecordCreationState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerTlsCertificateDnsRecordCreationState) SetCode added in v1.44.133 

func (s *LoadBalancerTlsCertificateDnsRecordCreationState) SetCode(v string) *LoadBalancerTlsCertificateDnsRecordCreationState

SetCode sets the Code field's value.

func (*LoadBalancerTlsCertificateDnsRecordCreationState) SetMessage added in v1.44.133 

func (s *LoadBalancerTlsCertificateDnsRecordCreationState) SetMessage(v string) *LoadBalancerTlsCertificateDnsRecordCreationState

SetMessage sets the Message field's value.

func (LoadBalancerTlsCertificateDnsRecordCreationState) String added in v1.44.133 

func (s LoadBalancerTlsCertificateDnsRecordCreationState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s LoadBalancerTlsCertificateDomainValidationOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerTlsCertificateDomainValidationOption) SetDomainName added in v1.12.37 

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

SetDomainName sets the DomainName field's value.

func (*LoadBalancerTlsCertificateDomainValidationOption) SetValidationStatus added in v1.12.37 

func (s *LoadBalancerTlsCertificateDomainValidationOption) SetValidationStatus(v string) *LoadBalancerTlsCertificateDomainValidationOption

SetValidationStatus sets the ValidationStatus field's value.

func (LoadBalancerTlsCertificateDomainValidationOption) String added in v1.12.37 

func (s LoadBalancerTlsCertificateDomainValidationOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoadBalancerTlsCertificateDomainValidationRecord added in v1.12.37 

type LoadBalancerTlsCertificateDomainValidationRecord struct {

	// An object that describes the state of the canonical name (CNAME) records
	// that are automatically added by Lightsail to the DNS of a domain to validate
	// domain ownership.
	DnsRecordCreationState *LoadBalancerTlsCertificateDnsRecordCreationState `locationName:"dnsRecordCreationState" type:"structure"`

	// 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 

func (s LoadBalancerTlsCertificateDomainValidationRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetDnsRecordCreationState added in v1.44.133 

func (s *LoadBalancerTlsCertificateDomainValidationRecord) SetDnsRecordCreationState(v *LoadBalancerTlsCertificateDnsRecordCreationState) *LoadBalancerTlsCertificateDomainValidationRecord

SetDnsRecordCreationState sets the DnsRecordCreationState field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetDomainName added in v1.12.37 

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

SetDomainName sets the DomainName field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetName added in v1.12.37 

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

SetName sets the Name field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetType added in v1.12.37 

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

SetType sets the Type field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetValidationStatus added in v1.12.37 

func (s *LoadBalancerTlsCertificateDomainValidationRecord) SetValidationStatus(v string) *LoadBalancerTlsCertificateDomainValidationRecord

SetValidationStatus sets the ValidationStatus field's value.

func (*LoadBalancerTlsCertificateDomainValidationRecord) SetValue added in v1.12.37 

func (s *LoadBalancerTlsCertificateDomainValidationRecord) SetValue(v string) *LoadBalancerTlsCertificateDomainValidationRecord

SetValue sets the Value field's value.

func (LoadBalancerTlsCertificateDomainValidationRecord) String added in v1.12.37 

func (s LoadBalancerTlsCertificateDomainValidationRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 renewal status of the certificate.
	//
	// The following renewal status are possible:
	//
	//    * PendingAutoRenewal - Lightsail is attempting to automatically validate
	//    the domain names of the certificate. No further action is required.
	//
	//    * PendingValidation - Lightsail couldn't automatically validate one or
	//    more domain names of the certificate. You must take action to validate
	//    these domain names or the certificate won't be renewed. Check to make
	//    sure your certificate's domain validation records exist in your domain's
	//    DNS, and that your certificate remains in use.
	//
	//    * Success - All domain names in the certificate are validated, and Lightsail
	//    renewed the certificate. No further action is required.
	//
	//    * Failed - One or more domain names were not validated before the certificate
	//    expired, and Lightsail did not renew the certificate. You can request
	//    a new certificate using the CreateCertificate action.
	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.

The renewal status of the certificate.

The following renewal status are possible:

  • PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names in the certificate. No further action is required.

  • PendingValidation - Lightsail couldn't automatically validate one or more domain names in the certificate. You must take action to validate these domain names or the certificate won't be renewed. If you used DNS validation, check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.

  • Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

  • Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

func (LoadBalancerTlsCertificateRenewalSummary) GoString added in v1.12.37 

func (s LoadBalancerTlsCertificateRenewalSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerTlsCertificateRenewalSummary) SetDomainValidationOptions added in v1.12.37 

func (s *LoadBalancerTlsCertificateRenewalSummary) SetDomainValidationOptions(v []*LoadBalancerTlsCertificateDomainValidationOption) *LoadBalancerTlsCertificateRenewalSummary

SetDomainValidationOptions sets the DomainValidationOptions field's value.

func (*LoadBalancerTlsCertificateRenewalSummary) SetRenewalStatus added in v1.12.37 

func (s *LoadBalancerTlsCertificateRenewalSummary) SetRenewalStatus(v string) *LoadBalancerTlsCertificateRenewalSummary

SetRenewalStatus sets the RenewalStatus field's value.

func (LoadBalancerTlsCertificateRenewalSummary) String added in v1.12.37 

func (s LoadBalancerTlsCertificateRenewalSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 

func (s LoadBalancerTlsCertificateSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerTlsCertificateSummary) SetIsAttached added in v1.12.37 

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

SetIsAttached sets the IsAttached field's value.

func (*LoadBalancerTlsCertificateSummary) SetName added in v1.12.37 

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

SetName sets the Name field's value.

func (LoadBalancerTlsCertificateSummary) String added in v1.12.37 

func (s LoadBalancerTlsCertificateSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoadBalancerTlsPolicy added in v1.44.1 

type LoadBalancerTlsPolicy struct {

	// The ciphers used by the TLS security policy.
	//
	// The ciphers are listed in order of preference.
	Ciphers []*string `locationName:"ciphers" type:"list"`

	// The description of the TLS security policy.
	Description *string `locationName:"description" type:"string"`

	// A Boolean value that indicates whether the TLS security policy is the default.
	IsDefault *bool `locationName:"isDefault" type:"boolean"`

	// The name of the TLS security policy.
	Name *string `locationName:"name" type:"string"`

	// The protocols used in a given TLS security policy.
	Protocols []*string `locationName:"protocols" type:"list"`
	// contains filtered or unexported fields
}

Describes the TLS security policies that are available for Lightsail load balancers.

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy) in the Amazon Lightsail Developer Guide.

func (LoadBalancerTlsPolicy) GoString added in v1.44.1 

func (s LoadBalancerTlsPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoadBalancerTlsPolicy) SetCiphers added in v1.44.1 

func (s *LoadBalancerTlsPolicy) SetCiphers(v []*string) *LoadBalancerTlsPolicy

SetCiphers sets the Ciphers field's value.

func (*LoadBalancerTlsPolicy) SetDescription added in v1.44.1 

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

SetDescription sets the Description field's value.

func (*LoadBalancerTlsPolicy) SetIsDefault added in v1.44.1 

func (s *LoadBalancerTlsPolicy) SetIsDefault(v bool) *LoadBalancerTlsPolicy

SetIsDefault sets the IsDefault field's value.

func (*LoadBalancerTlsPolicy) SetName added in v1.44.1 

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

SetName sets the Name field's value.

func (*LoadBalancerTlsPolicy) SetProtocols added in v1.44.1 

func (s *LoadBalancerTlsPolicy) SetProtocols(v []*string) *LoadBalancerTlsPolicy

SetProtocols sets the Protocols field's value.

func (LoadBalancerTlsPolicy) String added in v1.44.1 

func (s LoadBalancerTlsPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogEvent added in v1.15.56 

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

func (s LogEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogEvent) SetCreatedAt added in v1.15.56 

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

SetCreatedAt sets the CreatedAt field's value.

func (*LogEvent) SetMessage added in v1.15.56 

func (s *LogEvent) SetMessage(v string) *LogEvent

SetMessage sets the Message field's value.

func (LogEvent) String added in v1.15.56 

func (s LogEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MonitoredResourceInfo added in v1.29.12 

type MonitoredResourceInfo struct {

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

	// The name of the Lightsail resource being monitored.
	Name *string `locationName:"name" type:"string"`

	// The Lightsail resource type of the resource being monitored.
	//
	// Instances, load balancers, and relational databases are the only Lightsail
	// resources that can currently be monitored by alarms.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

Describes resource being monitored by an alarm.

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

func (MonitoredResourceInfo) GoString added in v1.29.12 

func (s MonitoredResourceInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MonitoredResourceInfo) SetArn added in v1.29.12 

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

SetArn sets the Arn field's value.

func (*MonitoredResourceInfo) SetName added in v1.29.12 

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

SetName sets the Name field's value.

func (*MonitoredResourceInfo) SetResourceType added in v1.29.12 

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

SetResourceType sets the ResourceType field's value.

func (MonitoredResourceInfo) String added in v1.29.12 

func (s MonitoredResourceInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NameServersUpdateState added in v1.44.133 

type NameServersUpdateState struct {

	// The status code for the name servers update.
	//
	// Following are the possible values:
	//
	//    * SUCCEEDED - The name server records were successfully updated.
	//
	//    * PENDING - The name server record update is in progress.
	//
	//    * FAILED - The name server record update failed.
	//
	//    * STARTED - The automatic name server record update started.
	Code *string `locationName:"code" type:"string" enum:"NameServersUpdateStateCode"`

	// The message that describes the reason for the status code.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain.

For more information, see DNS in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail) in the Amazon Lightsail Developer Guide.

func (NameServersUpdateState) GoString added in v1.44.133 

func (s NameServersUpdateState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NameServersUpdateState) SetCode added in v1.44.133 

func (s *NameServersUpdateState) SetCode(v string) *NameServersUpdateState

SetCode sets the Code field's value.

func (*NameServersUpdateState) SetMessage added in v1.44.133 

func (s *NameServersUpdateState) SetMessage(v string) *NameServersUpdateState

SetMessage sets the Message field's value.

func (NameServersUpdateState) String added in v1.44.133 

func (s NameServersUpdateState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotFoundException added in v1.28.0 

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"code" type:"string"`

	Docs *string `locationName:"docs" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	Tip *string `locationName:"tip" type:"string"`
	// contains filtered or unexported fields
}

Lightsail throws this exception when it cannot find a resource.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OpenInstancePublicPortsInput 

type OpenInstancePublicPortsInput struct {

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

	// An object to describe the ports to open for the specified instance.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OpenInstancePublicPortsInput) SetInstanceName 

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

SetInstanceName sets the InstanceName field's value.

func (*OpenInstancePublicPortsInput) SetPortInfo 

func (s *OpenInstancePublicPortsInput) SetPortInfo(v *PortInfo) *OpenInstancePublicPortsInput

SetPortInfo sets the PortInfo field's value.

func (OpenInstancePublicPortsInput) String 

func (s OpenInstancePublicPortsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (OpenInstancePublicPortsOutput) GoString 

func (s OpenInstancePublicPortsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OpenInstancePublicPortsOutput) SetOperation 

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

SetOperation sets the Operation field's value.

func (OpenInstancePublicPortsOutput) String 

func (s OpenInstancePublicPortsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OperationFailureException added in v1.28.0 

type OperationFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"code" type:"string"`

	Docs *string `locationName:"docs" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	Tip *string `locationName:"tip" type:"string"`
	// contains filtered or unexported fields
}

Lightsail throws this exception when an operation fails to execute.

func (*OperationFailureException) Code added in v1.28.0 

func (s *OperationFailureException) Code() string

Code returns the exception type name.

func (*OperationFailureException) Error added in v1.28.0 

func (s *OperationFailureException) Error() string

func (OperationFailureException) GoString added in v1.28.0 

func (s OperationFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperationFailureException) Message added in v1.28.0 

func (s *OperationFailureException) Message() string

Message returns the exception's message.

func (*OperationFailureException) OrigErr added in v1.28.0 

func (s *OperationFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperationFailureException) RequestID added in v1.28.0 

func (s *OperationFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperationFailureException) StatusCode added in v1.28.0 

func (s *OperationFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OperationFailureException) String added in v1.28.0 

func (s OperationFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Origin added in v1.33.11 

type Origin struct {

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

	// The protocol that your Amazon Lightsail distribution uses when establishing
	// a connection with your origin to pull content.
	ProtocolPolicy *string `locationName:"protocolPolicy" type:"string" enum:"OriginProtocolPolicyEnum"`

	// The AWS Region name of the origin resource.
	RegionName *string `locationName:"regionName" type:"string" enum:"RegionName"`

	// The resource type of the origin resource (e.g., Instance).
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

func (Origin) GoString added in v1.33.11 

func (s Origin) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Origin) SetName added in v1.33.11 

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

SetName sets the Name field's value.

func (*Origin) SetProtocolPolicy added in v1.33.11 

func (s *Origin) SetProtocolPolicy(v string) *Origin

SetProtocolPolicy sets the ProtocolPolicy field's value.

func (*Origin) SetRegionName added in v1.33.11 

func (s *Origin) SetRegionName(v string) *Origin

SetRegionName sets the RegionName field's value.

func (*Origin) SetResourceType added in v1.33.11 

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

SetResourceType sets the ResourceType field's value.

func (Origin) String added in v1.33.11 

func (s Origin) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PeerVpcInput 

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

func (PeerVpcInput) GoString 

func (s PeerVpcInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PeerVpcInput) String 

func (s PeerVpcInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PeerVpcOutput 

type PeerVpcOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (PeerVpcOutput) GoString 

func (s PeerVpcOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PendingMaintenanceAction added in v1.15.56 

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

func (s PendingMaintenanceAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingMaintenanceAction) SetAction added in v1.15.56 

func (s *PendingMaintenanceAction) SetAction(v string) *PendingMaintenanceAction

SetAction sets the Action field's value.

func (*PendingMaintenanceAction) SetCurrentApplyDate added in v1.15.56 

func (s *PendingMaintenanceAction) SetCurrentApplyDate(v time.Time) *PendingMaintenanceAction

SetCurrentApplyDate sets the CurrentApplyDate field's value.

func (*PendingMaintenanceAction) SetDescription added in v1.15.56 

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

SetDescription sets the Description field's value.

func (PendingMaintenanceAction) String added in v1.15.56 

func (s PendingMaintenanceAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PendingModifiedRelationalDatabaseValues added in v1.15.56 

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

func (s PendingModifiedRelationalDatabaseValues) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingModifiedRelationalDatabaseValues) SetBackupRetentionEnabled added in v1.15.56 

func (s *PendingModifiedRelationalDatabaseValues) SetBackupRetentionEnabled(v bool) *PendingModifiedRelationalDatabaseValues

SetBackupRetentionEnabled sets the BackupRetentionEnabled field's value.

func (*PendingModifiedRelationalDatabaseValues) SetEngineVersion added in v1.15.56 

func (s *PendingModifiedRelationalDatabaseValues) SetEngineVersion(v string) *PendingModifiedRelationalDatabaseValues

SetEngineVersion sets the EngineVersion field's value.

func (*PendingModifiedRelationalDatabaseValues) SetMasterUserPassword added in v1.15.56 

func (s *PendingModifiedRelationalDatabaseValues) SetMasterUserPassword(v string) *PendingModifiedRelationalDatabaseValues

SetMasterUserPassword sets the MasterUserPassword field's value.

func (PendingModifiedRelationalDatabaseValues) String added in v1.15.56 

func (s PendingModifiedRelationalDatabaseValues) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PortInfo 

type PortInfo struct {

	// An alias that defines access for a preconfigured range of IP addresses.
	//
	// The only alias currently supported is lightsail-connect, which allows IP
	// addresses of the browser-based RDP/SSH client in the Lightsail console to
	// connect to your instance.
	CidrListAliases []*string `locationName:"cidrListAliases" type:"list"`

	// The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are
	// allowed to connect to an instance through the ports, and the protocol.
	//
	// The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect
	// to an instance.
	//
	// Examples:
	//
	//    * To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.
	//
	//    * To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
	//
	// For more information about CIDR block notation, see Classless Inter-Domain
	// Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
	// on Wikipedia.
	Cidrs []*string `locationName:"cidrs" type:"list"`

	// The first port in a range of open ports on an instance.
	//
	// Allowed ports:
	//
	//    * TCP and UDP - 0 to 65535
	//
	//    * ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the
	//    fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP
	//    Ping. For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages)
	//    on Wikipedia.
	//
	//    * ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128
	//    as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more
	//    information, see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
	FromPort *int64 `locationName:"fromPort" type:"integer"`

	// The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are
	// allowed to connect to an instance through the ports, and the protocol. Only
	// devices with an IPv6 address can connect to an instance through IPv6; otherwise,
	// IPv4 should be used.
	//
	// The cidrs parameter lists the IPv4 addresses that are allowed to connect
	// to an instance.
	//
	// For more information about CIDR block notation, see Classless Inter-Domain
	// Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
	// on Wikipedia.
	Ipv6Cidrs []*string `locationName:"ipv6Cidrs" type:"list"`

	// The IP protocol name.
	//
	// The name can be one of the following:
	//
	//    * tcp - Transmission Control Protocol (TCP) provides reliable, ordered,
	//    and error-checked delivery of streamed data between applications running
	//    on hosts communicating by an IP network. If you have an application that
	//    doesn't require reliable data stream service, use UDP instead.
	//
	//    * all - All transport layer protocol types. For more general information,
	//    see Transport layer (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.
	//
	//    * icmp - Internet Control Message Protocol (ICMP) is used to send error
	//    messages and operational information indicating success or failure when
	//    communicating with an instance. For example, an error is indicated when
	//    an instance could not be reached. When you specify icmp as the protocol,
	//    you must specify the ICMP type using the fromPort parameter, and ICMP
	//    code using the toPort parameter.
	Protocol *string `locationName:"protocol" type:"string" enum:"NetworkProtocol"`

	// The last port in a range of open ports on an instance.
	//
	// Allowed ports:
	//
	//    * TCP and UDP - 0 to 65535
	//
	//    * ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the
	//    fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP
	//    Ping. For more information, see Control Messages (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages)
	//    on Wikipedia.
	//
	//    * ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128
	//    as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more
	//    information, see Internet Control Message Protocol for IPv6 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
	ToPort *int64 `locationName:"toPort" type:"integer"`
	// contains filtered or unexported fields
}

Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

func (PortInfo) GoString 

func (s PortInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortInfo) SetCidrListAliases added in v1.30.23 

func (s *PortInfo) SetCidrListAliases(v []*string) *PortInfo

SetCidrListAliases sets the CidrListAliases field's value.

func (*PortInfo) SetCidrs added in v1.30.23 

func (s *PortInfo) SetCidrs(v []*string) *PortInfo

SetCidrs sets the Cidrs field's value.

func (*PortInfo) SetFromPort 

func (s *PortInfo) SetFromPort(v int64) *PortInfo

SetFromPort sets the FromPort field's value.

func (*PortInfo) SetIpv6Cidrs added in v1.36.25 

func (s *PortInfo) SetIpv6Cidrs(v []*string) *PortInfo

SetIpv6Cidrs sets the Ipv6Cidrs 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortInfo) Validate added in v1.30.23 

func (s *PortInfo) Validate() error

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

type PrivateRegistryAccess added in v1.44.23 

type PrivateRegistryAccess struct {

	// An object that describes the activation status of the role that you can use
	// to grant a Lightsail container service access to Amazon ECR private repositories.
	// If the role is activated, the Amazon Resource Name (ARN) of the role is also
	// listed.
	EcrImagePullerRole *ContainerServiceECRImagePullerRole `locationName:"ecrImagePullerRole" type:"structure"`
	// contains filtered or unexported fields
}

Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) in the Amazon Lightsail Developer Guide.

func (PrivateRegistryAccess) GoString added in v1.44.23 

func (s PrivateRegistryAccess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PrivateRegistryAccess) SetEcrImagePullerRole added in v1.44.23 

func (s *PrivateRegistryAccess) SetEcrImagePullerRole(v *ContainerServiceECRImagePullerRole) *PrivateRegistryAccess

SetEcrImagePullerRole sets the EcrImagePullerRole field's value.

func (PrivateRegistryAccess) String added in v1.44.23 

func (s PrivateRegistryAccess) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PrivateRegistryAccessRequest added in v1.44.23 

type PrivateRegistryAccessRequest struct {

	// An object to describe a request to activate or deactivate the role that you
	// can use to grant an Amazon Lightsail container service access to Amazon Elastic
	// Container Registry (Amazon ECR) private repositories.
	EcrImagePullerRole *ContainerServiceECRImagePullerRoleRequest `locationName:"ecrImagePullerRole" type:"structure"`
	// contains filtered or unexported fields
}

Describes a request to configure an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access) in the Amazon Lightsail Developer Guide.

func (PrivateRegistryAccessRequest) GoString added in v1.44.23 

func (s PrivateRegistryAccessRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PrivateRegistryAccessRequest) SetEcrImagePullerRole added in v1.44.23 

func (s *PrivateRegistryAccessRequest) SetEcrImagePullerRole(v *ContainerServiceECRImagePullerRoleRequest) *PrivateRegistryAccessRequest

SetEcrImagePullerRole sets the EcrImagePullerRole field's value.

func (PrivateRegistryAccessRequest) String added in v1.44.23 

func (s PrivateRegistryAccessRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutAlarmInput added in v1.29.12 

type PutAlarmInput struct {

	// The name for the alarm. Specify the name of an existing alarm to update,
	// and overwrite the previous configuration of the alarm.
	//
	// AlarmName is a required field
	AlarmName *string `locationName:"alarmName" type:"string" required:"true"`

	// The arithmetic operation to use when comparing the specified statistic to
	// the threshold. The specified statistic value is used as the first operand.
	//
	// ComparisonOperator is a required field
	ComparisonOperator *string `locationName:"comparisonOperator" type:"string" required:"true" enum:"ComparisonOperator"`

	// The contact protocols to use for the alarm, such as Email, SMS (text messaging),
	// or both.
	//
	// A notification is sent via the specified contact protocol if notifications
	// are enabled for the alarm, and when the alarm is triggered.
	//
	// A notification is not sent if a contact protocol is not specified, if the
	// specified contact protocol is not configured in the Amazon Web Services Region,
	// or if notifications are not enabled for the alarm using the notificationEnabled
	// paramater.
	//
	// Use the CreateContactMethod action to configure a contact protocol in an
	// Amazon Web Services Region.
	ContactProtocols []*string `locationName:"contactProtocols" type:"list" enum:"ContactProtocol"`

	// The number of data points that must be not within the specified threshold
	// to trigger the alarm. If you are setting an "M out of N" alarm, this value
	// (datapointsToAlarm) is the M.
	DatapointsToAlarm *int64 `locationName:"datapointsToAlarm" type:"integer"`

	// The number of most recent periods over which data is compared to the specified
	// threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods)
	// is the N.
	//
	// If you are setting an alarm that requires that a number of consecutive data
	// points be breaching to trigger the alarm, this value specifies the rolling
	// period of time in which data points are evaluated.
	//
	// Each evaluation period is five minutes long. For example, specify an evaluation
	// period of 24 to evaluate a metric over a rolling period of two hours.
	//
	// You can specify a minimum valuation period of 1 (5 minutes), and a maximum
	// evaluation period of 288 (24 hours).
	//
	// EvaluationPeriods is a required field
	EvaluationPeriods *int64 `locationName:"evaluationPeriods" type:"integer" required:"true"`

	// The name of the metric to associate with the alarm.
	//
	// You can configure up to two alarms per metric.
	//
	// The following metrics are available for each resource type:
	//
	//    * Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization,
	//    NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance,
	//    and StatusCheckFailed_System.
	//
	//    * Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount,
	//    HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count,
	//    HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count,
	//    InstanceResponseTime, RejectedConnectionCount, and RequestCount.
	//
	//    * Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth,
	//    FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.
	//
	// For more information about these metrics, see Metrics available in Lightsail
	// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics).
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true" enum:"MetricName"`

	// The name of the Lightsail resource that will be monitored.
	//
	// Instances, load balancers, and relational databases are the only Lightsail
	// resources that can currently be monitored by alarms.
	//
	// MonitoredResourceName is a required field
	MonitoredResourceName *string `locationName:"monitoredResourceName" type:"string" required:"true"`

	// Indicates whether the alarm is enabled.
	//
	// Notifications are enabled by default if you don't specify this parameter.
	NotificationEnabled *bool `locationName:"notificationEnabled" type:"boolean"`

	// The alarm states that trigger a notification.
	//
	// An alarm has the following possible states:
	//
	//    * ALARM - The metric is outside of the defined threshold.
	//
	//    * INSUFFICIENT_DATA - The alarm has just started, the metric is not available,
	//    or not enough data is available for the metric to determine the alarm
	//    state.
	//
	//    * OK - The metric is within the defined threshold.
	//
	// When you specify a notification trigger, the ALARM state must be specified.
	// The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM
	// state.
	//
	//    * If you specify OK as an alarm trigger, a notification is sent when the
	//    alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK
	//    state. This can be thought of as an all clear alarm notification.
	//
	//    * If you specify INSUFFICIENT_DATA as the alarm trigger, a notification
	//    is sent when the alarm switches from an OK or ALARM alarm state to an
	//    INSUFFICIENT_DATA state.
	//
	// The notification trigger defaults to ALARM if you don't specify this parameter.
	NotificationTriggers []*string `locationName:"notificationTriggers" type:"list" enum:"AlarmState"`

	// The value against which the specified statistic is compared.
	//
	// Threshold is a required field
	Threshold *float64 `locationName:"threshold" type:"double" required:"true"`

	// Sets how this alarm will handle missing data points.
	//
	// An alarm can treat missing data in the following ways:
	//
	//    * breaching - Assume the missing data is not within the threshold. Missing
	//    data counts towards the number of times the metric is not within the threshold.
	//
	//    * notBreaching - Assume the missing data is within the threshold. Missing
	//    data does not count towards the number of times the metric is not within
	//    the threshold.
	//
	//    * ignore - Ignore the missing data. Maintains the current alarm state.
	//
	//    * missing - Missing data is treated as missing.
	//
	// If treatMissingData is not specified, the default behavior of missing is
	// used.
	TreatMissingData *string `locationName:"treatMissingData" type:"string" enum:"TreatMissingData"`
	// contains filtered or unexported fields
}

func (PutAlarmInput) GoString added in v1.29.12 

func (s PutAlarmInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAlarmInput) SetAlarmName added in v1.29.12 

func (s *PutAlarmInput) SetAlarmName(v string) *PutAlarmInput

SetAlarmName sets the AlarmName field's value.

func (*PutAlarmInput) SetComparisonOperator added in v1.29.12 

func (s *PutAlarmInput) SetComparisonOperator(v string) *PutAlarmInput

SetComparisonOperator sets the ComparisonOperator field's value.

func (*PutAlarmInput) SetContactProtocols added in v1.29.12 

func (s *PutAlarmInput) SetContactProtocols(v []*string) *PutAlarmInput

SetContactProtocols sets the ContactProtocols field's value.

func (*PutAlarmInput) SetDatapointsToAlarm added in v1.29.12 

func (s *PutAlarmInput) SetDatapointsToAlarm(v int64) *PutAlarmInput

SetDatapointsToAlarm sets the DatapointsToAlarm field's value.

func (*PutAlarmInput) SetEvaluationPeriods added in v1.29.12 

func (s *PutAlarmInput) SetEvaluationPeriods(v int64) *PutAlarmInput

SetEvaluationPeriods sets the EvaluationPeriods field's value.

func (*PutAlarmInput) SetMetricName added in v1.29.12 

func (s *PutAlarmInput) SetMetricName(v string) *PutAlarmInput

SetMetricName sets the MetricName field's value.

func (*PutAlarmInput) SetMonitoredResourceName added in v1.29.12 

func (s *PutAlarmInput) SetMonitoredResourceName(v string) *PutAlarmInput

SetMonitoredResourceName sets the MonitoredResourceName field's value.

func (*PutAlarmInput) SetNotificationEnabled added in v1.29.12 

func (s *PutAlarmInput) SetNotificationEnabled(v bool) *PutAlarmInput

SetNotificationEnabled sets the NotificationEnabled field's value.

func (*PutAlarmInput) SetNotificationTriggers added in v1.29.12 

func (s *PutAlarmInput) SetNotificationTriggers(v []*string) *PutAlarmInput

SetNotificationTriggers sets the NotificationTriggers field's value.

func (*PutAlarmInput) SetThreshold added in v1.29.12 

func (s *PutAlarmInput) SetThreshold(v float64) *PutAlarmInput

SetThreshold sets the Threshold field's value.

func (*PutAlarmInput) SetTreatMissingData added in v1.29.12 

func (s *PutAlarmInput) SetTreatMissingData(v string) *PutAlarmInput

SetTreatMissingData sets the TreatMissingData field's value.

func (PutAlarmInput) String added in v1.29.12 

func (s PutAlarmInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAlarmInput) Validate added in v1.29.12 

func (s *PutAlarmInput) Validate() error

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

type PutAlarmOutput added in v1.29.12 

type PutAlarmOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (PutAlarmOutput) GoString added in v1.29.12 

func (s PutAlarmOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAlarmOutput) SetOperations added in v1.29.12 

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

SetOperations sets the Operations field's value.

func (PutAlarmOutput) String added in v1.29.12 

func (s PutAlarmOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutInstancePublicPortsInput added in v1.8.26 

type PutInstancePublicPortsInput struct {

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

	// An array of objects to describe the ports to open for the specified instance.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutInstancePublicPortsInput) SetInstanceName added in v1.8.26 

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

SetInstanceName sets the InstanceName field's value.

func (*PutInstancePublicPortsInput) SetPortInfos added in v1.8.26 

func (s *PutInstancePublicPortsInput) SetPortInfos(v []*PortInfo) *PutInstancePublicPortsInput

SetPortInfos sets the PortInfos field's value.

func (PutInstancePublicPortsInput) String added in v1.8.26 

func (s PutInstancePublicPortsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutInstancePublicPortsOutput) SetOperation added in v1.8.26 

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

SetOperation sets the Operation field's value.

func (PutInstancePublicPortsOutput) String added in v1.8.26 

func (s PutInstancePublicPortsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryStringObject added in v1.33.11 

type QueryStringObject struct {

	// Indicates whether the distribution forwards and caches based on query strings.
	Option *bool `locationName:"option" type:"boolean"`

	// The specific query strings that the distribution forwards to the origin.
	//
	// Your distribution will cache content based on the specified query strings.
	//
	// If the option parameter is true, then your distribution forwards all query
	// strings, regardless of what you specify using the queryStringsAllowList parameter.
	QueryStringsAllowList []*string `locationName:"queryStringsAllowList" type:"list"`
	// contains filtered or unexported fields
}

Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.

func (QueryStringObject) GoString added in v1.33.11 

func (s QueryStringObject) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryStringObject) SetOption added in v1.33.11 

func (s *QueryStringObject) SetOption(v bool) *QueryStringObject

SetOption sets the Option field's value.

func (*QueryStringObject) SetQueryStringsAllowList added in v1.33.11 

func (s *QueryStringObject) SetQueryStringsAllowList(v []*string) *QueryStringObject

SetQueryStringsAllowList sets the QueryStringsAllowList field's value.

func (QueryStringObject) String added in v1.33.11 

func (s QueryStringObject) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type R53HostedZoneDeletionState added in v1.44.133 

type R53HostedZoneDeletionState struct {

	// The status code for the deletion state.
	//
	// Following are the possible values:
	//
	//    * SUCCEEDED - The hosted zone was successfully deleted.
	//
	//    * PENDING - The hosted zone deletion is in progress.
	//
	//    * FAILED - The hosted zone deletion failed.
	//
	//    * STARTED - The hosted zone deletion started.
	Code *string `locationName:"code" type:"string" enum:"R53HostedZoneDeletionStateCode"`

	// The message that describes the reason for the status code.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.

func (R53HostedZoneDeletionState) GoString added in v1.44.133 

func (s R53HostedZoneDeletionState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*R53HostedZoneDeletionState) SetCode added in v1.44.133 

func (s *R53HostedZoneDeletionState) SetCode(v string) *R53HostedZoneDeletionState

SetCode sets the Code field's value.

func (*R53HostedZoneDeletionState) SetMessage added in v1.44.133 

func (s *R53HostedZoneDeletionState) SetMessage(v string) *R53HostedZoneDeletionState

SetMessage sets the Message field's value.

func (R53HostedZoneDeletionState) String added in v1.44.133 

func (s R53HostedZoneDeletionState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (RebootInstanceOutput) GoString 

func (s RebootInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RebootRelationalDatabaseInput added in v1.15.56 

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

func (s RebootRelationalDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootRelationalDatabaseInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (RebootRelationalDatabaseInput) String added in v1.15.56 

func (s RebootRelationalDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootRelationalDatabaseInput) Validate added in v1.15.56 

func (s *RebootRelationalDatabaseInput) Validate() error

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

type RebootRelationalDatabaseOutput added in v1.15.56 

type RebootRelationalDatabaseOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (RebootRelationalDatabaseOutput) GoString added in v1.15.56 

func (s RebootRelationalDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootRelationalDatabaseOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (RebootRelationalDatabaseOutput) String added in v1.15.56 

func (s RebootRelationalDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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 Amazon Web Services Region.

func (Region) GoString 

func (s Region) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterContainerImageInput added in v1.35.27 

type RegisterContainerImageInput struct {

	// The digest of the container image to be registered.
	//
	// Digest is a required field
	Digest *string `locationName:"digest" type:"string" required:"true"`

	// The label for the container image when it's registered to the container service.
	//
	// Use a descriptive label that you can use to track the different versions
	// of your registered container images.
	//
	// Use the GetContainerImages action to return the container images registered
	// to a Lightsail container service. The label is the <imagelabel> portion of
	// the following image name example:
	//
	//    * :container-service-1.<imagelabel>.1
	//
	// If the name of your container service is mycontainerservice, and the label
	// that you specify is mystaticwebsite, then the name of the registered container
	// image will be :mycontainerservice.mystaticwebsite.1.
	//
	// The number at the end of these image name examples represents the version
	// of the registered container image. If you push and register another container
	// image to the same Lightsail container service, with the same label, then
	// the version number for the new registered container image will be 2. If you
	// push and register another container image, the version number will be 3,
	// and so on.
	//
	// Label is a required field
	Label *string `locationName:"label" min:"1" type:"string" required:"true"`

	// The name of the container service for which to register a container image.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterContainerImageInput) GoString added in v1.35.27 

func (s RegisterContainerImageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterContainerImageInput) SetDigest added in v1.35.27 

func (s *RegisterContainerImageInput) SetDigest(v string) *RegisterContainerImageInput

SetDigest sets the Digest field's value.

func (*RegisterContainerImageInput) SetLabel added in v1.35.27 

func (s *RegisterContainerImageInput) SetLabel(v string) *RegisterContainerImageInput

SetLabel sets the Label field's value.

func (*RegisterContainerImageInput) SetServiceName added in v1.35.27 

func (s *RegisterContainerImageInput) SetServiceName(v string) *RegisterContainerImageInput

SetServiceName sets the ServiceName field's value.

func (RegisterContainerImageInput) String added in v1.35.27 

func (s RegisterContainerImageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterContainerImageInput) Validate added in v1.35.27 

func (s *RegisterContainerImageInput) Validate() error

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

type RegisterContainerImageOutput added in v1.35.27 

type RegisterContainerImageOutput struct {

	// An object that describes a container image that is registered to a Lightsail
	// container service
	ContainerImage *ContainerImage `locationName:"containerImage" type:"structure"`
	// contains filtered or unexported fields
}

func (RegisterContainerImageOutput) GoString added in v1.35.27 

func (s RegisterContainerImageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterContainerImageOutput) SetContainerImage added in v1.35.27 

func (s *RegisterContainerImageOutput) SetContainerImage(v *ContainerImage) *RegisterContainerImageOutput

SetContainerImage sets the ContainerImage field's value.

func (RegisterContainerImageOutput) String added in v1.35.27 

func (s RegisterContainerImageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisteredDomainDelegationInfo added in v1.44.133 

type RegisteredDomainDelegationInfo struct {

	// An object that describes the state of the name server records that are automatically
	// added to the Route 53 domain by Lightsail.
	NameServersUpdateState *NameServersUpdateState `locationName:"nameServersUpdateState" type:"structure"`

	// Describes the deletion state of an Amazon Route 53 hosted zone for a domain
	// that is being automatically delegated to an Amazon Lightsail DNS zone.
	R53HostedZoneDeletionState *R53HostedZoneDeletionState `locationName:"r53HostedZoneDeletionState" type:"structure"`
	// contains filtered or unexported fields
}

Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.

When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain.

All of the following conditions must be true for automatic domain delegation to be successful:

  • The registered domain must be in the same Amazon Web Services account as the Lightsail account making the request.

  • The user or entity making the request must have permission to manage domains in Route 53.

  • The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records.

If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain’s records in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-create-dns-entry) in the Amazon Lightsail Developer Guide.

func (RegisteredDomainDelegationInfo) GoString added in v1.44.133 

func (s RegisteredDomainDelegationInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisteredDomainDelegationInfo) SetNameServersUpdateState added in v1.44.133 

func (s *RegisteredDomainDelegationInfo) SetNameServersUpdateState(v *NameServersUpdateState) *RegisteredDomainDelegationInfo

SetNameServersUpdateState sets the NameServersUpdateState field's value.

func (*RegisteredDomainDelegationInfo) SetR53HostedZoneDeletionState added in v1.44.133 

func (s *RegisteredDomainDelegationInfo) SetR53HostedZoneDeletionState(v *R53HostedZoneDeletionState) *RegisteredDomainDelegationInfo

SetR53HostedZoneDeletionState sets the R53HostedZoneDeletionState field's value.

func (RegisteredDomainDelegationInfo) String added in v1.44.133 

func (s RegisteredDomainDelegationInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelationalDatabase added in v1.15.56 

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 certificate associated with the database.
	CaCertificateIdentifier *string `locationName:"caCertificateIdentifier" type:"string"`

	// 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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
	Tags []*Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a database.

func (RelationalDatabase) GoString added in v1.15.56 

func (s RelationalDatabase) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationalDatabase) SetArn added in v1.15.56 

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

SetArn sets the Arn field's value.

func (*RelationalDatabase) SetBackupRetentionEnabled added in v1.15.56 

func (s *RelationalDatabase) SetBackupRetentionEnabled(v bool) *RelationalDatabase

SetBackupRetentionEnabled sets the BackupRetentionEnabled field's value.

func (*RelationalDatabase) SetCaCertificateIdentifier added in v1.27.0 

func (s *RelationalDatabase) SetCaCertificateIdentifier(v string) *RelationalDatabase

SetCaCertificateIdentifier sets the CaCertificateIdentifier field's value.

func (*RelationalDatabase) SetCreatedAt added in v1.15.56 

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

SetCreatedAt sets the CreatedAt field's value.

func (*RelationalDatabase) SetEngine added in v1.15.56 

func (s *RelationalDatabase) SetEngine(v string) *RelationalDatabase

SetEngine sets the Engine field's value.

func (*RelationalDatabase) SetEngineVersion added in v1.15.56 

func (s *RelationalDatabase) SetEngineVersion(v string) *RelationalDatabase

SetEngineVersion sets the EngineVersion field's value.

func (*RelationalDatabase) SetHardware added in v1.15.56 

func (s *RelationalDatabase) SetHardware(v *RelationalDatabaseHardware) *RelationalDatabase

SetHardware sets the Hardware field's value.

func (*RelationalDatabase) SetLatestRestorableTime added in v1.15.56 

func (s *RelationalDatabase) SetLatestRestorableTime(v time.Time) *RelationalDatabase

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*RelationalDatabase) SetLocation added in v1.15.56 

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

SetLocation sets the Location field's value.

func (*RelationalDatabase) SetMasterDatabaseName added in v1.15.56 

func (s *RelationalDatabase) SetMasterDatabaseName(v string) *RelationalDatabase

SetMasterDatabaseName sets the MasterDatabaseName field's value.

func (*RelationalDatabase) SetMasterEndpoint added in v1.15.56 

func (s *RelationalDatabase) SetMasterEndpoint(v *RelationalDatabaseEndpoint) *RelationalDatabase

SetMasterEndpoint sets the MasterEndpoint field's value.

func (*RelationalDatabase) SetMasterUsername added in v1.15.56 

func (s *RelationalDatabase) SetMasterUsername(v string) *RelationalDatabase

SetMasterUsername sets the MasterUsername field's value.

func (*RelationalDatabase) SetName added in v1.15.56 

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

SetName sets the Name field's value.

func (*RelationalDatabase) SetParameterApplyStatus added in v1.15.56 

func (s *RelationalDatabase) SetParameterApplyStatus(v string) *RelationalDatabase

SetParameterApplyStatus sets the ParameterApplyStatus field's value.

func (*RelationalDatabase) SetPendingMaintenanceActions added in v1.15.56 

func (s *RelationalDatabase) SetPendingMaintenanceActions(v []*PendingMaintenanceAction) *RelationalDatabase

SetPendingMaintenanceActions sets the PendingMaintenanceActions field's value.

func (*RelationalDatabase) SetPendingModifiedValues added in v1.15.56 

func (s *RelationalDatabase) SetPendingModifiedValues(v *PendingModifiedRelationalDatabaseValues) *RelationalDatabase

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*RelationalDatabase) SetPreferredBackupWindow added in v1.15.56 

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*RelationalDatabase) SetPreferredMaintenanceWindow added in v1.15.56 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*RelationalDatabase) SetPubliclyAccessible added in v1.15.56 

func (s *RelationalDatabase) SetPubliclyAccessible(v bool) *RelationalDatabase

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*RelationalDatabase) SetRelationalDatabaseBlueprintId added in v1.15.56 

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

SetRelationalDatabaseBlueprintId sets the RelationalDatabaseBlueprintId field's value.

func (*RelationalDatabase) SetRelationalDatabaseBundleId added in v1.15.56 

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

SetRelationalDatabaseBundleId sets the RelationalDatabaseBundleId field's value.

func (*RelationalDatabase) SetResourceType added in v1.15.56 

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

SetResourceType sets the ResourceType field's value.

func (*RelationalDatabase) SetSecondaryAvailabilityZone added in v1.15.56 

func (s *RelationalDatabase) SetSecondaryAvailabilityZone(v string) *RelationalDatabase

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*RelationalDatabase) SetState added in v1.15.56 

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

SetState sets the State field's value.

func (*RelationalDatabase) SetSupportCode added in v1.15.56 

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

SetSupportCode sets the SupportCode field's value.

func (*RelationalDatabase) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (RelationalDatabase) String added in v1.15.56 

func (s RelationalDatabase) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelationalDatabaseBlueprint added in v1.15.56 

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

func (s RelationalDatabaseBlueprint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationalDatabaseBlueprint) SetBlueprintId added in v1.15.56 

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

SetBlueprintId sets the BlueprintId field's value.

func (*RelationalDatabaseBlueprint) SetEngine added in v1.15.56 

func (s *RelationalDatabaseBlueprint) SetEngine(v string) *RelationalDatabaseBlueprint

SetEngine sets the Engine field's value.

func (*RelationalDatabaseBlueprint) SetEngineDescription added in v1.15.56 

func (s *RelationalDatabaseBlueprint) SetEngineDescription(v string) *RelationalDatabaseBlueprint

SetEngineDescription sets the EngineDescription field's value.

func (*RelationalDatabaseBlueprint) SetEngineVersion added in v1.15.56 

func (s *RelationalDatabaseBlueprint) SetEngineVersion(v string) *RelationalDatabaseBlueprint

SetEngineVersion sets the EngineVersion field's value.

func (*RelationalDatabaseBlueprint) SetEngineVersionDescription added in v1.15.56 

func (s *RelationalDatabaseBlueprint) SetEngineVersionDescription(v string) *RelationalDatabaseBlueprint

SetEngineVersionDescription sets the EngineVersionDescription field's value.

func (*RelationalDatabaseBlueprint) SetIsEngineDefault added in v1.15.56 

func (s *RelationalDatabaseBlueprint) SetIsEngineDefault(v bool) *RelationalDatabaseBlueprint

SetIsEngineDefault sets the IsEngineDefault field's value.

func (RelationalDatabaseBlueprint) String added in v1.15.56 

func (s RelationalDatabaseBlueprint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelationalDatabaseBundle added in v1.15.56 

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

func (s RelationalDatabaseBundle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationalDatabaseBundle) SetBundleId added in v1.15.56 

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

SetBundleId sets the BundleId field's value.

func (*RelationalDatabaseBundle) SetCpuCount added in v1.15.56 

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

SetCpuCount sets the CpuCount field's value.

func (*RelationalDatabaseBundle) SetDiskSizeInGb added in v1.15.56 

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

SetDiskSizeInGb sets the DiskSizeInGb field's value.

func (*RelationalDatabaseBundle) SetIsActive added in v1.15.56 

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

SetIsActive sets the IsActive field's value.

func (*RelationalDatabaseBundle) SetIsEncrypted added in v1.15.56 

func (s *RelationalDatabaseBundle) SetIsEncrypted(v bool) *RelationalDatabaseBundle

SetIsEncrypted sets the IsEncrypted field's value.

func (*RelationalDatabaseBundle) SetName added in v1.15.56 

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

SetName sets the Name field's value.

func (*RelationalDatabaseBundle) SetPrice added in v1.15.56 

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

SetPrice sets the Price field's value.

func (*RelationalDatabaseBundle) SetRamSizeInGb added in v1.15.56 

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

SetRamSizeInGb sets the RamSizeInGb field's value.

func (*RelationalDatabaseBundle) SetTransferPerMonthInGb added in v1.15.56 

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

SetTransferPerMonthInGb sets the TransferPerMonthInGb field's value.

func (RelationalDatabaseBundle) String added in v1.15.56 

func (s RelationalDatabaseBundle) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelationalDatabaseEndpoint added in v1.15.56 

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

func (s RelationalDatabaseEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationalDatabaseEndpoint) SetAddress added in v1.15.56 

func (s *RelationalDatabaseEndpoint) SetAddress(v string) *RelationalDatabaseEndpoint

SetAddress sets the Address field's value.

func (*RelationalDatabaseEndpoint) SetPort added in v1.15.56 

func (s *RelationalDatabaseEndpoint) SetPort(v int64) *RelationalDatabaseEndpoint

SetPort sets the Port field's value.

func (RelationalDatabaseEndpoint) String added in v1.15.56 

func (s RelationalDatabaseEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelationalDatabaseEvent added in v1.15.56 

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

func (s RelationalDatabaseEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationalDatabaseEvent) SetCreatedAt added in v1.15.56 

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

SetCreatedAt sets the CreatedAt field's value.

func (*RelationalDatabaseEvent) SetEventCategories added in v1.15.56 

func (s *RelationalDatabaseEvent) SetEventCategories(v []*string) *RelationalDatabaseEvent

SetEventCategories sets the EventCategories field's value.

func (*RelationalDatabaseEvent) SetMessage added in v1.15.56 

func (s *RelationalDatabaseEvent) SetMessage(v string) *RelationalDatabaseEvent

SetMessage sets the Message field's value.

func (*RelationalDatabaseEvent) SetResource added in v1.15.56 

func (s *RelationalDatabaseEvent) SetResource(v string) *RelationalDatabaseEvent

SetResource sets the Resource field's value.

func (RelationalDatabaseEvent) String added in v1.15.56 

func (s RelationalDatabaseEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelationalDatabaseHardware added in v1.15.56 

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

func (s RelationalDatabaseHardware) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationalDatabaseHardware) SetCpuCount added in v1.15.56 

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

SetCpuCount sets the CpuCount field's value.

func (*RelationalDatabaseHardware) SetDiskSizeInGb added in v1.15.56 

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

SetDiskSizeInGb sets the DiskSizeInGb field's value.

func (*RelationalDatabaseHardware) SetRamSizeInGb added in v1.15.56 

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

SetRamSizeInGb sets the RamSizeInGb field's value.

func (RelationalDatabaseHardware) String added in v1.15.56 

func (s RelationalDatabaseHardware) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelationalDatabaseParameter added in v1.15.56 

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

func (s RelationalDatabaseParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationalDatabaseParameter) SetAllowedValues added in v1.15.56 

func (s *RelationalDatabaseParameter) SetAllowedValues(v string) *RelationalDatabaseParameter

SetAllowedValues sets the AllowedValues field's value.

func (*RelationalDatabaseParameter) SetApplyMethod added in v1.15.56 

func (s *RelationalDatabaseParameter) SetApplyMethod(v string) *RelationalDatabaseParameter

SetApplyMethod sets the ApplyMethod field's value.

func (*RelationalDatabaseParameter) SetApplyType added in v1.15.56 

func (s *RelationalDatabaseParameter) SetApplyType(v string) *RelationalDatabaseParameter

SetApplyType sets the ApplyType field's value.

func (*RelationalDatabaseParameter) SetDataType added in v1.15.56 

func (s *RelationalDatabaseParameter) SetDataType(v string) *RelationalDatabaseParameter

SetDataType sets the DataType field's value.

func (*RelationalDatabaseParameter) SetDescription added in v1.15.56 

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

SetDescription sets the Description field's value.

func (*RelationalDatabaseParameter) SetIsModifiable added in v1.15.56 

func (s *RelationalDatabaseParameter) SetIsModifiable(v bool) *RelationalDatabaseParameter

SetIsModifiable sets the IsModifiable field's value.

func (*RelationalDatabaseParameter) SetParameterName added in v1.15.56 

func (s *RelationalDatabaseParameter) SetParameterName(v string) *RelationalDatabaseParameter

SetParameterName sets the ParameterName field's value.

func (*RelationalDatabaseParameter) SetParameterValue added in v1.15.56 

func (s *RelationalDatabaseParameter) SetParameterValue(v string) *RelationalDatabaseParameter

SetParameterValue sets the ParameterValue field's value.

func (RelationalDatabaseParameter) String added in v1.15.56 

func (s RelationalDatabaseParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelationalDatabaseSnapshot added in v1.15.56 

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/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.15.56 

func (s RelationalDatabaseSnapshot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelationalDatabaseSnapshot) SetArn added in v1.15.56 

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

SetArn sets the Arn field's value.

func (*RelationalDatabaseSnapshot) SetCreatedAt added in v1.15.56 

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

SetCreatedAt sets the CreatedAt field's value.

func (*RelationalDatabaseSnapshot) SetEngine added in v1.15.56 

func (s *RelationalDatabaseSnapshot) SetEngine(v string) *RelationalDatabaseSnapshot

SetEngine sets the Engine field's value.

func (*RelationalDatabaseSnapshot) SetEngineVersion added in v1.15.56 

func (s *RelationalDatabaseSnapshot) SetEngineVersion(v string) *RelationalDatabaseSnapshot

SetEngineVersion sets the EngineVersion field's value.

func (*RelationalDatabaseSnapshot) SetFromRelationalDatabaseArn added in v1.15.56 

func (s *RelationalDatabaseSnapshot) SetFromRelationalDatabaseArn(v string) *RelationalDatabaseSnapshot

SetFromRelationalDatabaseArn sets the FromRelationalDatabaseArn field's value.

func (*RelationalDatabaseSnapshot) SetFromRelationalDatabaseBlueprintId added in v1.15.56 

func (s *RelationalDatabaseSnapshot) SetFromRelationalDatabaseBlueprintId(v string) *RelationalDatabaseSnapshot

SetFromRelationalDatabaseBlueprintId sets the FromRelationalDatabaseBlueprintId field's value.

func (*RelationalDatabaseSnapshot) SetFromRelationalDatabaseBundleId added in v1.15.56 

func (s *RelationalDatabaseSnapshot) SetFromRelationalDatabaseBundleId(v string) *RelationalDatabaseSnapshot

SetFromRelationalDatabaseBundleId sets the FromRelationalDatabaseBundleId field's value.

func (*RelationalDatabaseSnapshot) SetFromRelationalDatabaseName added in v1.15.56 

func (s *RelationalDatabaseSnapshot) SetFromRelationalDatabaseName(v string) *RelationalDatabaseSnapshot

SetFromRelationalDatabaseName sets the FromRelationalDatabaseName field's value.

func (*RelationalDatabaseSnapshot) SetLocation added in v1.15.56 

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

SetLocation sets the Location field's value.

func (*RelationalDatabaseSnapshot) SetName added in v1.15.56 

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

SetName sets the Name field's value.

func (*RelationalDatabaseSnapshot) SetResourceType added in v1.15.56 

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

SetResourceType sets the ResourceType field's value.

func (*RelationalDatabaseSnapshot) SetSizeInGb added in v1.15.56 

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

SetSizeInGb sets the SizeInGb field's value.

func (*RelationalDatabaseSnapshot) SetState added in v1.15.56 

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

SetState sets the State field's value.

func (*RelationalDatabaseSnapshot) SetSupportCode added in v1.15.56 

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

SetSupportCode sets the SupportCode field's value.

func (*RelationalDatabaseSnapshot) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (RelationalDatabaseSnapshot) String added in v1.15.56 

func (s RelationalDatabaseSnapshot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (ReleaseStaticIpOutput) GoString 

func (s ReleaseStaticIpOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RenewalSummary added in v1.33.11 

type RenewalSummary struct {

	// An array of objects that describe the domain validation records of the certificate.
	DomainValidationRecords []*DomainValidationRecord `locationName:"domainValidationRecords" type:"list"`

	// The renewal status of the certificate.
	//
	// The following renewal status are possible:
	//
	//    * PendingAutoRenewal - Lightsail is attempting to automatically validate
	//    the domain names of the certificate. No further action is required.
	//
	//    * PendingValidation - Lightsail couldn't automatically validate one or
	//    more domain names of the certificate. You must take action to validate
	//    these domain names or the certificate won't be renewed. Check to make
	//    sure your certificate's domain validation records exist in your domain's
	//    DNS, and that your certificate remains in use.
	//
	//    * Success - All domain names in the certificate are validated, and Lightsail
	//    renewed the certificate. No further action is required.
	//
	//    * Failed - One or more domain names were not validated before the certificate
	//    expired, and Lightsail did not renew the certificate. You can request
	//    a new certificate using the CreateCertificate action.
	RenewalStatus *string `locationName:"renewalStatus" type:"string" enum:"RenewalStatus"`

	// The reason for the renewal status of the certificate.
	RenewalStatusReason *string `locationName:"renewalStatusReason" type:"string"`

	// The timestamp when the certificate was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

func (RenewalSummary) GoString added in v1.33.11 

func (s RenewalSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RenewalSummary) SetDomainValidationRecords added in v1.33.11 

func (s *RenewalSummary) SetDomainValidationRecords(v []*DomainValidationRecord) *RenewalSummary

SetDomainValidationRecords sets the DomainValidationRecords field's value.

func (*RenewalSummary) SetRenewalStatus added in v1.33.11 

func (s *RenewalSummary) SetRenewalStatus(v string) *RenewalSummary

SetRenewalStatus sets the RenewalStatus field's value.

func (*RenewalSummary) SetRenewalStatusReason added in v1.33.11 

func (s *RenewalSummary) SetRenewalStatusReason(v string) *RenewalSummary

SetRenewalStatusReason sets the RenewalStatusReason field's value.

func (*RenewalSummary) SetUpdatedAt added in v1.33.11 

func (s *RenewalSummary) SetUpdatedAt(v time.Time) *RenewalSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (RenewalSummary) String added in v1.33.11 

func (s RenewalSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResetDistributionCacheInput added in v1.33.11 

type ResetDistributionCacheInput struct {

	// The name of the distribution for which to reset cache.
	//
	// Use the GetDistributions action to get a list of distribution names that
	// you can specify.
	DistributionName *string `locationName:"distributionName" type:"string"`
	// contains filtered or unexported fields
}

func (ResetDistributionCacheInput) GoString added in v1.33.11 

func (s ResetDistributionCacheInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetDistributionCacheInput) SetDistributionName added in v1.33.11 

func (s *ResetDistributionCacheInput) SetDistributionName(v string) *ResetDistributionCacheInput

SetDistributionName sets the DistributionName field's value.

func (ResetDistributionCacheInput) String added in v1.33.11 

func (s ResetDistributionCacheInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResetDistributionCacheOutput added in v1.33.11 

type ResetDistributionCacheOutput struct {

	// The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time
	// format.
	CreateTime *time.Time `locationName:"createTime" type:"timestamp"`

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`

	// The status of the reset cache request.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

func (ResetDistributionCacheOutput) GoString added in v1.33.11 

func (s ResetDistributionCacheOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResetDistributionCacheOutput) SetCreateTime added in v1.33.11 

func (s *ResetDistributionCacheOutput) SetCreateTime(v time.Time) *ResetDistributionCacheOutput

SetCreateTime sets the CreateTime field's value.

func (*ResetDistributionCacheOutput) SetOperation added in v1.33.11 

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

SetOperation sets the Operation field's value.

func (*ResetDistributionCacheOutput) SetStatus added in v1.33.11 

func (s *ResetDistributionCacheOutput) SetStatus(v string) *ResetDistributionCacheOutput

SetStatus sets the Status field's value.

func (ResetDistributionCacheOutput) String added in v1.33.11 

func (s ResetDistributionCacheOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceLocation 

type ResourceLocation struct {

	// The Availability Zone. Follows the format us-east-2a (case-sensitive).
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceReceivingAccess added in v1.40.0 

type ResourceReceivingAccess struct {

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

	// The Lightsail resource type (for example, Instance).
	ResourceType *string `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

func (ResourceReceivingAccess) GoString added in v1.40.0 

func (s ResourceReceivingAccess) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceReceivingAccess) SetName added in v1.40.0 

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

SetName sets the Name field's value.

func (*ResourceReceivingAccess) SetResourceType added in v1.40.0 

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

SetResourceType sets the ResourceType field's value.

func (ResourceReceivingAccess) String added in v1.40.0 

func (s ResourceReceivingAccess) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceRecord added in v1.33.11 

type ResourceRecord struct {

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

	// The DNS record type.
	Type *string `locationName:"type" type:"string"`

	// The value for the DNS record.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Describes the domain name system (DNS) records to add to your domain's DNS to validate it for an Amazon Lightsail certificate.

func (ResourceRecord) GoString added in v1.33.11 

func (s ResourceRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceRecord) SetName added in v1.33.11 

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

SetName sets the Name field's value.

func (*ResourceRecord) SetType added in v1.33.11 

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

SetType sets the Type field's value.

func (*ResourceRecord) SetValue added in v1.33.11 

func (s *ResourceRecord) SetValue(v string) *ResourceRecord

SetValue sets the Value field's value.

func (ResourceRecord) String added in v1.33.11 

func (s ResourceRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SendContactMethodVerificationInput added in v1.29.12 

type SendContactMethodVerificationInput struct {

	// The protocol to verify, such as Email or SMS (text messaging).
	//
	// Protocol is a required field
	Protocol *string `locationName:"protocol" type:"string" required:"true" enum:"ContactMethodVerificationProtocol"`
	// contains filtered or unexported fields
}

func (SendContactMethodVerificationInput) GoString added in v1.29.12 

func (s SendContactMethodVerificationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendContactMethodVerificationInput) SetProtocol added in v1.29.12 

func (s *SendContactMethodVerificationInput) SetProtocol(v string) *SendContactMethodVerificationInput

SetProtocol sets the Protocol field's value.

func (SendContactMethodVerificationInput) String added in v1.29.12 

func (s SendContactMethodVerificationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendContactMethodVerificationInput) Validate added in v1.29.12 

func (s *SendContactMethodVerificationInput) Validate() error

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

type SendContactMethodVerificationOutput added in v1.29.12 

type SendContactMethodVerificationOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (SendContactMethodVerificationOutput) GoString added in v1.29.12 

func (s SendContactMethodVerificationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SendContactMethodVerificationOutput) SetOperations added in v1.29.12 

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

SetOperations sets the Operations field's value.

func (SendContactMethodVerificationOutput) String added in v1.29.12 

func (s SendContactMethodVerificationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceException added in v1.28.0 

type ServiceException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"code" type:"string"`

	Docs *string `locationName:"docs" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	Tip *string `locationName:"tip" type:"string"`
	// contains filtered or unexported fields
}

A general service exception.

func (*ServiceException) Code added in v1.28.0 

func (s *ServiceException) Code() string

Code returns the exception type name.

func (*ServiceException) Error added in v1.28.0 

func (s *ServiceException) Error() string

func (ServiceException) GoString added in v1.28.0 

func (s ServiceException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceException) Message added in v1.28.0 

func (s *ServiceException) Message() string

Message returns the exception's message.

func (*ServiceException) OrigErr added in v1.28.0 

func (s *ServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceException) RequestID added in v1.28.0 

func (s *ServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceException) StatusCode added in v1.28.0 

func (s *ServiceException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceException) String added in v1.28.0 

func (s ServiceException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetIpAddressTypeInput added in v1.36.25 

type SetIpAddressTypeInput struct {

	// The IP address type to set for the specified resource.
	//
	// The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
	//
	// IpAddressType is a required field
	IpAddressType *string `locationName:"ipAddressType" type:"string" required:"true" enum:"IpAddressType"`

	// The name of the resource for which to set the IP address type.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`

	// The resource type.
	//
	// The possible values are Distribution, Instance, and LoadBalancer.
	//
	// Distribution-related APIs are available only in the N. Virginia (us-east-1)
	// Amazon Web Services Region. Set your Amazon Web Services Region configuration
	// to us-east-1 to create, view, or edit distributions.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true" enum:"ResourceType"`
	// contains filtered or unexported fields
}

func (SetIpAddressTypeInput) GoString added in v1.36.25 

func (s SetIpAddressTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetIpAddressTypeInput) SetIpAddressType added in v1.36.25 

func (s *SetIpAddressTypeInput) SetIpAddressType(v string) *SetIpAddressTypeInput

SetIpAddressType sets the IpAddressType field's value.

func (*SetIpAddressTypeInput) SetResourceName added in v1.36.25 

func (s *SetIpAddressTypeInput) SetResourceName(v string) *SetIpAddressTypeInput

SetResourceName sets the ResourceName field's value.

func (*SetIpAddressTypeInput) SetResourceType added in v1.36.25 

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

SetResourceType sets the ResourceType field's value.

func (SetIpAddressTypeInput) String added in v1.36.25 

func (s SetIpAddressTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetIpAddressTypeInput) Validate added in v1.36.25 

func (s *SetIpAddressTypeInput) Validate() error

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

type SetIpAddressTypeOutput added in v1.36.25 

type SetIpAddressTypeOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (SetIpAddressTypeOutput) GoString added in v1.36.25 

func (s SetIpAddressTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetIpAddressTypeOutput) SetOperations added in v1.36.25 

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

SetOperations sets the Operations field's value.

func (SetIpAddressTypeOutput) String added in v1.36.25 

func (s SetIpAddressTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetResourceAccessForBucketInput added in v1.40.0 

type SetResourceAccessForBucketInput struct {

	// The access setting.
	//
	// The following access settings are available:
	//
	//    * allow - Allows access to the bucket and its objects.
	//
	//    * deny - Denies access to the bucket and its objects. Use this setting
	//    to remove access for a resource previously set to allow.
	//
	// Access is a required field
	Access *string `locationName:"access" type:"string" required:"true" enum:"ResourceBucketAccess"`

	// The name of the bucket for which to set access to another Lightsail resource.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`

	// The name of the Lightsail instance for which to set bucket access. The instance
	// must be in a running or stopped state.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SetResourceAccessForBucketInput) GoString added in v1.40.0 

func (s SetResourceAccessForBucketInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetResourceAccessForBucketInput) SetAccess added in v1.40.0 

func (s *SetResourceAccessForBucketInput) SetAccess(v string) *SetResourceAccessForBucketInput

SetAccess sets the Access field's value.

func (*SetResourceAccessForBucketInput) SetBucketName added in v1.40.0 

func (s *SetResourceAccessForBucketInput) SetBucketName(v string) *SetResourceAccessForBucketInput

SetBucketName sets the BucketName field's value.

func (*SetResourceAccessForBucketInput) SetResourceName added in v1.40.0 

func (s *SetResourceAccessForBucketInput) SetResourceName(v string) *SetResourceAccessForBucketInput

SetResourceName sets the ResourceName field's value.

func (SetResourceAccessForBucketInput) String added in v1.40.0 

func (s SetResourceAccessForBucketInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetResourceAccessForBucketInput) Validate added in v1.40.0 

func (s *SetResourceAccessForBucketInput) Validate() error

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

type SetResourceAccessForBucketOutput added in v1.40.0 

type SetResourceAccessForBucketOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (SetResourceAccessForBucketOutput) GoString added in v1.40.0 

func (s SetResourceAccessForBucketOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetResourceAccessForBucketOutput) SetOperations added in v1.40.0 

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

SetOperations sets the Operations field's value.

func (SetResourceAccessForBucketOutput) String added in v1.40.0 

func (s SetResourceAccessForBucketOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (StartInstanceOutput) GoString 

func (s StartInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartRelationalDatabaseInput added in v1.15.56 

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

func (s StartRelationalDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartRelationalDatabaseInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (StartRelationalDatabaseInput) String added in v1.15.56 

func (s StartRelationalDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartRelationalDatabaseInput) Validate added in v1.15.56 

func (s *StartRelationalDatabaseInput) Validate() error

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

type StartRelationalDatabaseOutput added in v1.15.56 

type StartRelationalDatabaseOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (StartRelationalDatabaseOutput) GoString added in v1.15.56 

func (s StartRelationalDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartRelationalDatabaseOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (StartRelationalDatabaseOutput) String added in v1.15.56 

func (s StartRelationalDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 a static IP.

func (StaticIp) GoString 

func (s StaticIp) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (StopInstanceOutput) GoString 

func (s StopInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopRelationalDatabaseInput added in v1.15.56 

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

func (s StopRelationalDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopRelationalDatabaseInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*StopRelationalDatabaseInput) SetRelationalDatabaseSnapshotName added in v1.15.56 

func (s *StopRelationalDatabaseInput) SetRelationalDatabaseSnapshotName(v string) *StopRelationalDatabaseInput

SetRelationalDatabaseSnapshotName sets the RelationalDatabaseSnapshotName field's value.

func (StopRelationalDatabaseInput) String added in v1.15.56 

func (s StopRelationalDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopRelationalDatabaseInput) Validate added in v1.15.56 

func (s *StopRelationalDatabaseInput) Validate() error

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

type StopRelationalDatabaseOutput added in v1.15.56 

type StopRelationalDatabaseOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (StopRelationalDatabaseOutput) GoString added in v1.15.56 

func (s StopRelationalDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopRelationalDatabaseOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (StopRelationalDatabaseOutput) String added in v1.15.56 

func (s StopRelationalDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.15.86 

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 Amazon Lightsail Developer Guide (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).

func (Tag) GoString added in v1.15.86 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.15.86 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.15.86 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.15.86 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.15.86 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to which you want to add a
	// tag.
	ResourceArn *string `locationName:"resourceArn" type:"string"`

	// 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.15.86 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.25.4 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetResourceName added in v1.15.86 

func (s *TagResourceInput) SetResourceName(v string) *TagResourceInput

SetResourceName sets the ResourceName field's value.

func (*TagResourceInput) SetTags added in v1.15.86 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.15.86 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.15.86 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.15.86 

type TagResourceOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.15.86 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceOutput) SetOperations added in v1.15.86 

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

SetOperations sets the Operations field's value.

func (TagResourceOutput) String added in v1.15.86 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestAlarmInput added in v1.29.12 

type TestAlarmInput struct {

	// The name of the alarm to test.
	//
	// AlarmName is a required field
	AlarmName *string `locationName:"alarmName" type:"string" required:"true"`

	// The alarm state to test.
	//
	// An alarm has the following possible states that can be tested:
	//
	//    * ALARM - The metric is outside of the defined threshold.
	//
	//    * INSUFFICIENT_DATA - The alarm has just started, the metric is not available,
	//    or not enough data is available for the metric to determine the alarm
	//    state.
	//
	//    * OK - The metric is within the defined threshold.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"AlarmState"`
	// contains filtered or unexported fields
}

func (TestAlarmInput) GoString added in v1.29.12 

func (s TestAlarmInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestAlarmInput) SetAlarmName added in v1.29.12 

func (s *TestAlarmInput) SetAlarmName(v string) *TestAlarmInput

SetAlarmName sets the AlarmName field's value.

func (*TestAlarmInput) SetState added in v1.29.12 

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

SetState sets the State field's value.

func (TestAlarmInput) String added in v1.29.12 

func (s TestAlarmInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestAlarmInput) Validate added in v1.29.12 

func (s *TestAlarmInput) Validate() error

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

type TestAlarmOutput added in v1.29.12 

type TestAlarmOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (TestAlarmOutput) GoString added in v1.29.12 

func (s TestAlarmOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestAlarmOutput) SetOperations added in v1.29.12 

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

SetOperations sets the Operations field's value.

func (TestAlarmOutput) String added in v1.29.12 

func (s TestAlarmOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthenticatedException added in v1.28.0 

type UnauthenticatedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"code" type:"string"`

	Docs *string `locationName:"docs" type:"string"`

	Message_ *string `locationName:"message" type:"string"`

	Tip *string `locationName:"tip" type:"string"`
	// contains filtered or unexported fields
}

Lightsail throws this exception when the user has not been authenticated.

func (*UnauthenticatedException) Code added in v1.28.0 

func (s *UnauthenticatedException) Code() string

Code returns the exception type name.

func (*UnauthenticatedException) Error added in v1.28.0 

func (s *UnauthenticatedException) Error() string

func (UnauthenticatedException) GoString added in v1.28.0 

func (s UnauthenticatedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthenticatedException) Message added in v1.28.0 

func (s *UnauthenticatedException) Message() string

Message returns the exception's message.

func (*UnauthenticatedException) OrigErr added in v1.28.0 

func (s *UnauthenticatedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthenticatedException) RequestID added in v1.28.0 

func (s *UnauthenticatedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthenticatedException) StatusCode added in v1.28.0 

func (s *UnauthenticatedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthenticatedException) String added in v1.28.0 

func (s UnauthenticatedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnpeerVpcInput 

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

func (UnpeerVpcInput) GoString 

func (s UnpeerVpcInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UnpeerVpcInput) String 

func (s UnpeerVpcInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnpeerVpcOutput 

type UnpeerVpcOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (UnpeerVpcOutput) GoString 

func (s UnpeerVpcOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.15.86 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which you want to remove
	// a tag.
	ResourceArn *string `locationName:"resourceArn" type:"string"`

	// 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.15.86 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.25.4 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetResourceName added in v1.15.86 

func (s *UntagResourceInput) SetResourceName(v string) *UntagResourceInput

SetResourceName sets the ResourceName field's value.

func (*UntagResourceInput) SetTagKeys added in v1.15.86 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.15.86 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.15.86 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.15.86 

type UntagResourceOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.15.86 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceOutput) SetOperations added in v1.15.86 

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

SetOperations sets the Operations field's value.

func (UntagResourceOutput) String added in v1.15.86 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateBucketBundleInput added in v1.40.0 

type UpdateBucketBundleInput struct {

	// The name of the bucket for which to update the bundle.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`

	// The ID of the new bundle to apply to the bucket.
	//
	// Use the GetBucketBundles (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html)
	// action to get a list of bundle IDs that you can specify.
	//
	// BundleId is a required field
	BundleId *string `locationName:"bundleId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBucketBundleInput) GoString added in v1.40.0 

func (s UpdateBucketBundleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBucketBundleInput) SetBucketName added in v1.40.0 

func (s *UpdateBucketBundleInput) SetBucketName(v string) *UpdateBucketBundleInput

SetBucketName sets the BucketName field's value.

func (*UpdateBucketBundleInput) SetBundleId added in v1.40.0 

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

SetBundleId sets the BundleId field's value.

func (UpdateBucketBundleInput) String added in v1.40.0 

func (s UpdateBucketBundleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBucketBundleInput) Validate added in v1.40.0 

func (s *UpdateBucketBundleInput) Validate() error

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

type UpdateBucketBundleOutput added in v1.40.0 

type UpdateBucketBundleOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateBucketBundleOutput) GoString added in v1.40.0 

func (s UpdateBucketBundleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBucketBundleOutput) SetOperations added in v1.40.0 

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

SetOperations sets the Operations field's value.

func (UpdateBucketBundleOutput) String added in v1.40.0 

func (s UpdateBucketBundleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateBucketInput added in v1.40.0 

type UpdateBucketInput struct {

	// An object that describes the access log configuration for the bucket.
	AccessLogConfig *BucketAccessLogConfig `locationName:"accessLogConfig" type:"structure"`

	// An object that sets the public accessibility of objects in the specified
	// bucket.
	AccessRules *AccessRules `locationName:"accessRules" type:"structure"`

	// The name of the bucket to update.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`

	// An array of strings to specify the Amazon Web Services account IDs that can
	// access the bucket.
	//
	// You can give a maximum of 10 Amazon Web Services accounts access to a bucket.
	ReadonlyAccessAccounts []*string `locationName:"readonlyAccessAccounts" type:"list"`

	// Specifies whether to enable or suspend versioning of objects in the bucket.
	//
	// The following options can be specified:
	//
	//    * Enabled - Enables versioning of objects in the specified bucket.
	//
	//    * Suspended - Suspends versioning of objects in the specified bucket.
	//    Existing object versions are retained.
	Versioning *string `locationName:"versioning" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateBucketInput) GoString added in v1.40.0 

func (s UpdateBucketInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBucketInput) SetAccessLogConfig added in v1.41.15 

func (s *UpdateBucketInput) SetAccessLogConfig(v *BucketAccessLogConfig) *UpdateBucketInput

SetAccessLogConfig sets the AccessLogConfig field's value.

func (*UpdateBucketInput) SetAccessRules added in v1.40.0 

func (s *UpdateBucketInput) SetAccessRules(v *AccessRules) *UpdateBucketInput

SetAccessRules sets the AccessRules field's value.

func (*UpdateBucketInput) SetBucketName added in v1.40.0 

func (s *UpdateBucketInput) SetBucketName(v string) *UpdateBucketInput

SetBucketName sets the BucketName field's value.

func (*UpdateBucketInput) SetReadonlyAccessAccounts added in v1.40.0 

func (s *UpdateBucketInput) SetReadonlyAccessAccounts(v []*string) *UpdateBucketInput

SetReadonlyAccessAccounts sets the ReadonlyAccessAccounts field's value.

func (*UpdateBucketInput) SetVersioning added in v1.40.0 

func (s *UpdateBucketInput) SetVersioning(v string) *UpdateBucketInput

SetVersioning sets the Versioning field's value.

func (UpdateBucketInput) String added in v1.40.0 

func (s UpdateBucketInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBucketInput) Validate added in v1.40.0 

func (s *UpdateBucketInput) Validate() error

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

type UpdateBucketOutput added in v1.40.0 

type UpdateBucketOutput struct {

	// An object that describes the bucket that is updated.
	Bucket *Bucket `locationName:"bucket" type:"structure"`

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateBucketOutput) GoString added in v1.40.0 

func (s UpdateBucketOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBucketOutput) SetBucket added in v1.40.0 

func (s *UpdateBucketOutput) SetBucket(v *Bucket) *UpdateBucketOutput

SetBucket sets the Bucket field's value.

func (*UpdateBucketOutput) SetOperations added in v1.40.0 

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

SetOperations sets the Operations field's value.

func (UpdateBucketOutput) String added in v1.40.0 

func (s UpdateBucketOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateContainerServiceInput added in v1.35.27 

type UpdateContainerServiceInput struct {

	// A Boolean value to indicate whether the container service is disabled.
	IsDisabled *bool `locationName:"isDisabled" type:"boolean"`

	// The power for the container service.
	//
	// The power specifies the amount of memory, vCPUs, and base monthly cost of
	// each node of the container service. The power and scale of a container service
	// makes up its configured capacity. To determine the monthly price of your
	// container service, multiply the base price of the power with the scale (the
	// number of nodes) of the service.
	//
	// Use the GetContainerServicePowers action to view the specifications of each
	// power option.
	Power *string `locationName:"power" type:"string" enum:"ContainerServicePowerName"`

	// An object to describe the configuration for the container service to access
	// private container image repositories, such as Amazon Elastic Container Registry
	// (Amazon ECR) private repositories.
	//
	// For more information, see Configuring access to an Amazon ECR private repository
	// for an Amazon Lightsail container service (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access)
	// in the Amazon Lightsail Developer Guide.
	PrivateRegistryAccess *PrivateRegistryAccessRequest `locationName:"privateRegistryAccess" type:"structure"`

	// The public domain names to use with the container service, such as example.com
	// and www.example.com.
	//
	// You can specify up to four public domain names for a container service. The
	// domain names that you specify are used when you create a deployment with
	// a container configured as the public endpoint of your container service.
	//
	// If you don't specify public domain names, then you can use the default domain
	// of the container service.
	//
	// You must create and validate an SSL/TLS certificate before you can use public
	// domain names with your container service. Use the CreateCertificate action
	// to create a certificate for the public domain names you want to use with
	// your container service.
	//
	// You can specify public domain names using a string to array map as shown
	// in the example later on this page.
	PublicDomainNames map[string][]*string `locationName:"publicDomainNames" type:"map"`

	// The scale for the container service.
	//
	// The scale specifies the allocated compute nodes of the container service.
	// The power and scale of a container service makes up its configured capacity.
	// To determine the monthly price of your container service, multiply the base
	// price of the power with the scale (the number of nodes) of the service.
	Scale *int64 `locationName:"scale" min:"1" type:"integer"`

	// The name of the container service to update.
	//
	// ServiceName is a required field
	ServiceName *string `locationName:"serviceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateContainerServiceInput) GoString added in v1.35.27 

func (s UpdateContainerServiceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContainerServiceInput) SetIsDisabled added in v1.35.27 

func (s *UpdateContainerServiceInput) SetIsDisabled(v bool) *UpdateContainerServiceInput

SetIsDisabled sets the IsDisabled field's value.

func (*UpdateContainerServiceInput) SetPower added in v1.35.27 

func (s *UpdateContainerServiceInput) SetPower(v string) *UpdateContainerServiceInput

SetPower sets the Power field's value.

func (*UpdateContainerServiceInput) SetPrivateRegistryAccess added in v1.44.23 

func (s *UpdateContainerServiceInput) SetPrivateRegistryAccess(v *PrivateRegistryAccessRequest) *UpdateContainerServiceInput

SetPrivateRegistryAccess sets the PrivateRegistryAccess field's value.

func (*UpdateContainerServiceInput) SetPublicDomainNames added in v1.35.27 

func (s *UpdateContainerServiceInput) SetPublicDomainNames(v map[string][]*string) *UpdateContainerServiceInput

SetPublicDomainNames sets the PublicDomainNames field's value.

func (*UpdateContainerServiceInput) SetScale added in v1.35.27 

func (s *UpdateContainerServiceInput) SetScale(v int64) *UpdateContainerServiceInput

SetScale sets the Scale field's value.

func (*UpdateContainerServiceInput) SetServiceName added in v1.35.27 

func (s *UpdateContainerServiceInput) SetServiceName(v string) *UpdateContainerServiceInput

SetServiceName sets the ServiceName field's value.

func (UpdateContainerServiceInput) String added in v1.35.27 

func (s UpdateContainerServiceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContainerServiceInput) Validate added in v1.35.27 

func (s *UpdateContainerServiceInput) Validate() error

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

type UpdateContainerServiceOutput added in v1.35.27 

type UpdateContainerServiceOutput struct {

	// An object that describes a container service.
	ContainerService *ContainerService `locationName:"containerService" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateContainerServiceOutput) GoString added in v1.35.27 

func (s UpdateContainerServiceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateContainerServiceOutput) SetContainerService added in v1.35.27 

func (s *UpdateContainerServiceOutput) SetContainerService(v *ContainerService) *UpdateContainerServiceOutput

SetContainerService sets the ContainerService field's value.

func (UpdateContainerServiceOutput) String added in v1.35.27 

func (s UpdateContainerServiceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDistributionBundleInput added in v1.33.11 

type UpdateDistributionBundleInput struct {

	// The bundle ID of the new bundle to apply to your distribution.
	//
	// Use the GetDistributionBundles action to get a list of distribution bundle
	// IDs that you can specify.
	BundleId *string `locationName:"bundleId" type:"string"`

	// The name of the distribution for which to update the bundle.
	//
	// Use the GetDistributions action to get a list of distribution names that
	// you can specify.
	DistributionName *string `locationName:"distributionName" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateDistributionBundleInput) GoString added in v1.33.11 

func (s UpdateDistributionBundleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDistributionBundleInput) SetBundleId added in v1.33.11 

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

SetBundleId sets the BundleId field's value.

func (*UpdateDistributionBundleInput) SetDistributionName added in v1.33.11 

func (s *UpdateDistributionBundleInput) SetDistributionName(v string) *UpdateDistributionBundleInput

SetDistributionName sets the DistributionName field's value.

func (UpdateDistributionBundleInput) String added in v1.33.11 

func (s UpdateDistributionBundleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDistributionBundleOutput added in v1.33.11 

type UpdateDistributionBundleOutput struct {

	// An object that describes the result of the action, such as the status of
	// the request, the timestamp of the request, and the resources affected by
	// the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDistributionBundleOutput) GoString added in v1.33.11 

func (s UpdateDistributionBundleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDistributionBundleOutput) SetOperation added in v1.33.11 

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

SetOperation sets the Operation field's value.

func (UpdateDistributionBundleOutput) String added in v1.33.11 

func (s UpdateDistributionBundleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDistributionInput added in v1.33.11 

type UpdateDistributionInput struct {

	// An object that describes the cache behavior settings for the distribution.
	//
	// The cacheBehaviorSettings specified in your UpdateDistributionRequest will
	// replace your distribution's existing settings.
	CacheBehaviorSettings *CacheSettings `locationName:"cacheBehaviorSettings" type:"structure"`

	// An array of objects that describe the per-path cache behavior for the distribution.
	CacheBehaviors []*CacheBehaviorPerPath `locationName:"cacheBehaviors" type:"list"`

	// An object that describes the default cache behavior for the distribution.
	DefaultCacheBehavior *CacheBehavior `locationName:"defaultCacheBehavior" type:"structure"`

	// The name of the distribution to update.
	//
	// Use the GetDistributions action to get a list of distribution names that
	// you can specify.
	//
	// DistributionName is a required field
	DistributionName *string `locationName:"distributionName" type:"string" required:"true"`

	// Indicates whether to enable the distribution.
	IsEnabled *bool `locationName:"isEnabled" type:"boolean"`

	// An object that describes the origin resource for the distribution, such as
	// a Lightsail instance, bucket, or load balancer.
	//
	// The distribution pulls, caches, and serves content from the origin.
	Origin *InputOrigin `locationName:"origin" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDistributionInput) GoString added in v1.33.11 

func (s UpdateDistributionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDistributionInput) SetCacheBehaviorSettings added in v1.33.11 

func (s *UpdateDistributionInput) SetCacheBehaviorSettings(v *CacheSettings) *UpdateDistributionInput

SetCacheBehaviorSettings sets the CacheBehaviorSettings field's value.

func (*UpdateDistributionInput) SetCacheBehaviors added in v1.33.11 

func (s *UpdateDistributionInput) SetCacheBehaviors(v []*CacheBehaviorPerPath) *UpdateDistributionInput

SetCacheBehaviors sets the CacheBehaviors field's value.

func (*UpdateDistributionInput) SetDefaultCacheBehavior added in v1.33.11 

func (s *UpdateDistributionInput) SetDefaultCacheBehavior(v *CacheBehavior) *UpdateDistributionInput

SetDefaultCacheBehavior sets the DefaultCacheBehavior field's value.

func (*UpdateDistributionInput) SetDistributionName added in v1.33.11 

func (s *UpdateDistributionInput) SetDistributionName(v string) *UpdateDistributionInput

SetDistributionName sets the DistributionName field's value.

func (*UpdateDistributionInput) SetIsEnabled added in v1.33.11 

func (s *UpdateDistributionInput) SetIsEnabled(v bool) *UpdateDistributionInput

SetIsEnabled sets the IsEnabled field's value.

func (*UpdateDistributionInput) SetOrigin added in v1.33.11 

func (s *UpdateDistributionInput) SetOrigin(v *InputOrigin) *UpdateDistributionInput

SetOrigin sets the Origin field's value.

func (UpdateDistributionInput) String added in v1.33.11 

func (s UpdateDistributionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDistributionInput) Validate added in v1.33.11 

func (s *UpdateDistributionInput) Validate() error

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

type UpdateDistributionOutput added in v1.33.11 

type UpdateDistributionOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDistributionOutput) GoString added in v1.33.11 

func (s UpdateDistributionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDistributionOutput) SetOperation added in v1.33.11 

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

SetOperation sets the Operation field's value.

func (UpdateDistributionOutput) String added in v1.33.11 

func (s UpdateDistributionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainEntryInput) SetDomainEntry 

func (s *UpdateDomainEntryInput) SetDomainEntry(v *DomainEntry) *UpdateDomainEntryInput

SetDomainEntry sets the DomainEntry field's value.

func (*UpdateDomainEntryInput) SetDomainName 

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

SetDomainName sets the DomainName field's value.

func (UpdateDomainEntryInput) String 

func (s UpdateDomainEntryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateDomainEntryOutput) GoString 

func (s UpdateDomainEntryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainEntryOutput) SetOperations 

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

SetOperations sets the Operations field's value.

func (UpdateDomainEntryOutput) String 

func (s UpdateDomainEntryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateInstanceMetadataOptionsInput added in v1.44.105 

type UpdateInstanceMetadataOptionsInput struct {

	// Enables or disables the HTTP metadata endpoint on your instances. If this
	// parameter is not specified, the existing state is maintained.
	//
	// If you specify a value of disabled, you cannot access your instance metadata.
	HttpEndpoint *string `locationName:"httpEndpoint" type:"string" enum:"HttpEndpoint"`

	// Enables or disables the IPv6 endpoint for the instance metadata service.
	// This setting applies only when the HTTP metadata endpoint is enabled.
	//
	// This parameter is available only for instances in the Europe (Stockholm)
	// Amazon Web Services Region (eu-north-1).
	HttpProtocolIpv6 *string `locationName:"httpProtocolIpv6" type:"string" enum:"HttpProtocolIpv6"`

	// The desired HTTP PUT response hop limit for instance metadata requests. A
	// larger number means that the instance metadata requests can travel farther.
	// If no parameter is specified, the existing state is maintained.
	HttpPutResponseHopLimit *int64 `locationName:"httpPutResponseHopLimit" type:"integer"`

	// The state of token usage for your instance metadata requests. If the parameter
	// is not specified in the request, the default state is optional.
	//
	// If the state is optional, you can choose whether to retrieve instance metadata
	// with a signed token header on your request. If you retrieve the IAM role
	// credentials without a token, the version 1.0 role credentials are returned.
	// If you retrieve the IAM role credentials by using a valid signed token, the
	// version 2.0 role credentials are returned.
	//
	// If the state is required, you must send a signed token header with all instance
	// metadata retrieval requests. In this state, retrieving the IAM role credential
	// always returns the version 2.0 credentials. The version 1.0 credentials are
	// not available.
	HttpTokens *string `locationName:"httpTokens" type:"string" enum:"HttpTokens"`

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

func (UpdateInstanceMetadataOptionsInput) GoString added in v1.44.105 

func (s UpdateInstanceMetadataOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInstanceMetadataOptionsInput) SetHttpEndpoint added in v1.44.105 

func (s *UpdateInstanceMetadataOptionsInput) SetHttpEndpoint(v string) *UpdateInstanceMetadataOptionsInput

SetHttpEndpoint sets the HttpEndpoint field's value.

func (*UpdateInstanceMetadataOptionsInput) SetHttpProtocolIpv6 added in v1.44.105 

func (s *UpdateInstanceMetadataOptionsInput) SetHttpProtocolIpv6(v string) *UpdateInstanceMetadataOptionsInput

SetHttpProtocolIpv6 sets the HttpProtocolIpv6 field's value.

func (*UpdateInstanceMetadataOptionsInput) SetHttpPutResponseHopLimit added in v1.44.105 

func (s *UpdateInstanceMetadataOptionsInput) SetHttpPutResponseHopLimit(v int64) *UpdateInstanceMetadataOptionsInput

SetHttpPutResponseHopLimit sets the HttpPutResponseHopLimit field's value.

func (*UpdateInstanceMetadataOptionsInput) SetHttpTokens added in v1.44.105 

func (s *UpdateInstanceMetadataOptionsInput) SetHttpTokens(v string) *UpdateInstanceMetadataOptionsInput

SetHttpTokens sets the HttpTokens field's value.

func (*UpdateInstanceMetadataOptionsInput) SetInstanceName added in v1.44.105 

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

SetInstanceName sets the InstanceName field's value.

func (UpdateInstanceMetadataOptionsInput) String added in v1.44.105 

func (s UpdateInstanceMetadataOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInstanceMetadataOptionsInput) Validate added in v1.44.105 

func (s *UpdateInstanceMetadataOptionsInput) Validate() error

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

type UpdateInstanceMetadataOptionsOutput added in v1.44.105 

type UpdateInstanceMetadataOptionsOutput struct {

	// Describes the API operation.
	Operation *Operation `locationName:"operation" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateInstanceMetadataOptionsOutput) GoString added in v1.44.105 

func (s UpdateInstanceMetadataOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInstanceMetadataOptionsOutput) SetOperation added in v1.44.105 

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

SetOperation sets the Operation field's value.

func (UpdateInstanceMetadataOptionsOutput) String added in v1.44.105 

func (s UpdateInstanceMetadataOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLoadBalancerAttributeInput added in v1.12.37 

type UpdateLoadBalancerAttributeInput struct {

	// The name of the attribute you want to update.
	//
	// 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.
	//
	// The following values are supported depending on what you specify for the
	// attributeName request parameter:
	//
	//    * If you specify HealthCheckPath for the attributeName request parameter,
	//    then the attributeValue request parameter must be the path to ping on
	//    the target (for example, /weather/us/wa/seattle).
	//
	//    * If you specify SessionStickinessEnabled for the attributeName request
	//    parameter, then the attributeValue request parameter must be true to activate
	//    session stickiness or false to deactivate session stickiness.
	//
	//    * If you specify SessionStickiness_LB_CookieDurationSeconds for the attributeName
	//    request parameter, then the attributeValue request parameter must be an
	//    interger that represents the cookie duration in seconds.
	//
	//    * If you specify HttpsRedirectionEnabled for the attributeName request
	//    parameter, then the attributeValue request parameter must be true to activate
	//    HTTP to HTTPS redirection or false to deactivate HTTP to HTTPS redirection.
	//
	//    * If you specify TlsPolicyName for the attributeName request parameter,
	//    then the attributeValue request parameter must be the name of the TLS
	//    policy. Use the GetLoadBalancerTlsPolicies (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html)
	//    action to get a list of TLS policy names that you can specify.
	//
	// 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 

func (s UpdateLoadBalancerAttributeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoadBalancerAttributeInput) SetAttributeName added in v1.12.37 

func (s *UpdateLoadBalancerAttributeInput) SetAttributeName(v string) *UpdateLoadBalancerAttributeInput

SetAttributeName sets the AttributeName field's value.

func (*UpdateLoadBalancerAttributeInput) SetAttributeValue added in v1.12.37 

func (s *UpdateLoadBalancerAttributeInput) SetAttributeValue(v string) *UpdateLoadBalancerAttributeInput

SetAttributeValue sets the AttributeValue field's value.

func (*UpdateLoadBalancerAttributeInput) SetLoadBalancerName added in v1.12.37 

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

SetLoadBalancerName sets the LoadBalancerName field's value.

func (UpdateLoadBalancerAttributeInput) String added in v1.12.37 

func (s UpdateLoadBalancerAttributeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoadBalancerAttributeInput) Validate added in v1.12.37 

func (s *UpdateLoadBalancerAttributeInput) Validate() error

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

type UpdateLoadBalancerAttributeOutput added in v1.12.37 

type UpdateLoadBalancerAttributeOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateLoadBalancerAttributeOutput) GoString added in v1.12.37 

func (s UpdateLoadBalancerAttributeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoadBalancerAttributeOutput) SetOperations added in v1.12.37 

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

SetOperations sets the Operations field's value.

func (UpdateLoadBalancerAttributeOutput) String added in v1.12.37 

func (s UpdateLoadBalancerAttributeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRelationalDatabaseInput added in v1.15.56 

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

	// Indicates the certificate that needs to be associated with the database.
	CaCertificateIdentifier *string `locationName:"caCertificateIdentifier" type:"string"`

	// When true, disables automated backup retention for your database.
	//
	// Disabling backup retention deletes all automated database backups. Before
	// disabling this, you may want to create a snapshot of your database using
	// the create relational database snapshot operation.
	//
	// Updates are applied during the next maintenance window because this can result
	// in an outage.
	DisableBackupRetention *bool `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. The password can include any printable
	// ASCII character except "/", """, or "@".
	//
	// MySQL
	//
	// Constraints: Must contain from 8 to 41 characters.
	//
	// PostgreSQL
	//
	// Constraints: Must contain from 8 to 128 characters.
	//
	// MasterUserPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateRelationalDatabaseInput's
	// String and GoString methods.
	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 Coordinated Universal 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 Amazon Web Services Region, occurring on a random day of
	// the week.
	//
	// Constraints:
	//
	//    * Must be in the ddd:hh24:mi-ddd:hh24:mi format.
	//
	//    * Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
	//
	//    * Must be at least 30 minutes.
	//
	//    * Specified in Coordinated Universal Time (UTC).
	//
	//    * Example: Tue:17:00-Tue:17:30
	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 Lightsail database resource 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.15.56 

func (s UpdateRelationalDatabaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRelationalDatabaseInput) SetApplyImmediately added in v1.15.56 

func (s *UpdateRelationalDatabaseInput) SetApplyImmediately(v bool) *UpdateRelationalDatabaseInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*UpdateRelationalDatabaseInput) SetCaCertificateIdentifier added in v1.27.0 

func (s *UpdateRelationalDatabaseInput) SetCaCertificateIdentifier(v string) *UpdateRelationalDatabaseInput

SetCaCertificateIdentifier sets the CaCertificateIdentifier field's value.

func (*UpdateRelationalDatabaseInput) SetDisableBackupRetention added in v1.15.56 

func (s *UpdateRelationalDatabaseInput) SetDisableBackupRetention(v bool) *UpdateRelationalDatabaseInput

SetDisableBackupRetention sets the DisableBackupRetention field's value.

func (*UpdateRelationalDatabaseInput) SetEnableBackupRetention added in v1.15.56 

func (s *UpdateRelationalDatabaseInput) SetEnableBackupRetention(v bool) *UpdateRelationalDatabaseInput

SetEnableBackupRetention sets the EnableBackupRetention field's value.

func (*UpdateRelationalDatabaseInput) SetMasterUserPassword added in v1.15.56 

func (s *UpdateRelationalDatabaseInput) SetMasterUserPassword(v string) *UpdateRelationalDatabaseInput

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*UpdateRelationalDatabaseInput) SetPreferredBackupWindow added in v1.15.56 

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*UpdateRelationalDatabaseInput) SetPreferredMaintenanceWindow added in v1.15.56 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*UpdateRelationalDatabaseInput) SetPubliclyAccessible added in v1.15.56 

func (s *UpdateRelationalDatabaseInput) SetPubliclyAccessible(v bool) *UpdateRelationalDatabaseInput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*UpdateRelationalDatabaseInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (*UpdateRelationalDatabaseInput) SetRotateMasterUserPassword added in v1.15.56 

func (s *UpdateRelationalDatabaseInput) SetRotateMasterUserPassword(v bool) *UpdateRelationalDatabaseInput

SetRotateMasterUserPassword sets the RotateMasterUserPassword field's value.

func (UpdateRelationalDatabaseInput) String added in v1.15.56 

func (s UpdateRelationalDatabaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRelationalDatabaseInput) Validate added in v1.15.56 

func (s *UpdateRelationalDatabaseInput) Validate() error

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

type UpdateRelationalDatabaseOutput added in v1.15.56 

type UpdateRelationalDatabaseOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateRelationalDatabaseOutput) GoString added in v1.15.56 

func (s UpdateRelationalDatabaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRelationalDatabaseOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (UpdateRelationalDatabaseOutput) String added in v1.15.56 

func (s UpdateRelationalDatabaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRelationalDatabaseParametersInput added in v1.15.56 

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

func (s UpdateRelationalDatabaseParametersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRelationalDatabaseParametersInput) SetParameters added in v1.15.56 

func (s *UpdateRelationalDatabaseParametersInput) SetParameters(v []*RelationalDatabaseParameter) *UpdateRelationalDatabaseParametersInput

SetParameters sets the Parameters field's value.

func (*UpdateRelationalDatabaseParametersInput) SetRelationalDatabaseName added in v1.15.56 

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

SetRelationalDatabaseName sets the RelationalDatabaseName field's value.

func (UpdateRelationalDatabaseParametersInput) String added in v1.15.56 

func (s UpdateRelationalDatabaseParametersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRelationalDatabaseParametersInput) Validate added in v1.15.56 

func (s *UpdateRelationalDatabaseParametersInput) Validate() error

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

type UpdateRelationalDatabaseParametersOutput added in v1.15.56 

type UpdateRelationalDatabaseParametersOutput struct {

	// An array of objects that describe the result of the action, such as the status
	// of the request, the timestamp of the request, and the resources affected
	// by the request.
	Operations []*Operation `locationName:"operations" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateRelationalDatabaseParametersOutput) GoString added in v1.15.56 

func (s UpdateRelationalDatabaseParametersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRelationalDatabaseParametersOutput) SetOperations added in v1.15.56 

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

SetOperations sets the Operations field's value.

func (UpdateRelationalDatabaseParametersOutput) String added in v1.15.56 

func (s UpdateRelationalDatabaseParametersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.