AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

LoadBalancer

import "github.com/aws/aws-sdk-go/service/lightsail"

type LoadBalancer struct { Arn *string `locationName:"arn" type:"string"` ConfigurationOptions map[string]*string `locationName:"configurationOptions" type:"map"` CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` DnsName *string `locationName:"dnsName" type:"string"` HealthCheckPath *string `locationName:"healthCheckPath" type:"string"` InstanceHealthSummary []*InstanceHealthSummary `locationName:"instanceHealthSummary" type:"list"` InstancePort *int64 `locationName:"instancePort" type:"integer"` Location *ResourceLocation `locationName:"location" type:"structure"` Name *string `locationName:"name" type:"string"` Protocol *string `locationName:"protocol" type:"string" enum:"LoadBalancerProtocol"` PublicPorts []*int64 `locationName:"publicPorts" type:"list"` ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"` State *string `locationName:"state" type:"string" enum:"LoadBalancerState"` SupportCode *string `locationName:"supportCode" type:"string"` Tags []*Tag `locationName:"tags" type:"list"` TlsCertificateSummaries []*LoadBalancerTlsCertificateSummary `locationName:"tlsCertificateSummaries" type:"list"` }

Describes the Lightsail load balancer.

Arn

Type: *string

The Amazon Resource Name (ARN) of the load balancer.

ConfigurationOptions

Type: map[string]*string

A string to string map of the configuration options for your load balancer. Valid values are listed below.

CreatedAt

Type: *time.Time

The date when your load balancer was created.

DnsName

Type: *string

The DNS name of your Lightsail load balancer.

HealthCheckPath

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.

InstanceHealthSummary

Describes information about the health of the instance.

InstancePort

Type: *int64

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.

Location

Describes the resource location.

Name

Type: *string

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

Protocol

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.

PublicPorts

Type: []*int64

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

ResourceType

Type: *string

The resource type (e.g., LoadBalancer.

State

Type: *string

The status of your load balancer. Valid values are below.

SupportCode

Type: *string

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.

Tags

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags).

TlsCertificateSummaries

Provides a summary of SSL/TLS certificate metadata.

Method

GoString

func (s LoadBalancer) GoString() string

GoString returns the string representation

SetArn

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

SetArn sets the Arn field's value.

SetConfigurationOptions

func (s *LoadBalancer) SetConfigurationOptions(v map[string]*string) *LoadBalancer

SetConfigurationOptions sets the ConfigurationOptions field's value.

SetCreatedAt

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

SetCreatedAt sets the CreatedAt field's value.

SetDnsName

func (s *LoadBalancer) SetDnsName(v string) *LoadBalancer

SetDnsName sets the DnsName field's value.

SetHealthCheckPath

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

SetHealthCheckPath sets the HealthCheckPath field's value.

SetInstanceHealthSummary

func (s *LoadBalancer) SetInstanceHealthSummary(v []*InstanceHealthSummary) *LoadBalancer

SetInstanceHealthSummary sets the InstanceHealthSummary field's value.

SetInstancePort

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

SetInstancePort sets the InstancePort field's value.

SetLocation

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

SetLocation sets the Location field's value.

SetName

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

SetName sets the Name field's value.

SetProtocol

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

SetProtocol sets the Protocol field's value.

SetPublicPorts

func (s *LoadBalancer) SetPublicPorts(v []*int64) *LoadBalancer

SetPublicPorts sets the PublicPorts field's value.

SetResourceType

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

SetResourceType sets the ResourceType field's value.

SetState

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

SetState sets the State field's value.

SetSupportCode

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

SetSupportCode sets the SupportCode field's value.

SetTags

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

SetTags sets the Tags field's value.

SetTlsCertificateSummaries

func (s *LoadBalancer) SetTlsCertificateSummaries(v []*LoadBalancerTlsCertificateSummary) *LoadBalancer

SetTlsCertificateSummaries sets the TlsCertificateSummaries field's value.

String

func (s LoadBalancer) String() string

String returns the string representation

On this page: