« blib/lib/Paws/Lightsail/LightsailDistribution.pm
↑ Summary
blib/lib/Paws/Lightsail/LoadBalancerConfigurationOptions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::LoadBalancer; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has ConfigurationOptions => (is => 'ro', isa => 'Paws::Lightsail::LoadBalancerConfigurationOptions', request_name => 'configurationOptions', traits => ['NameInRequest']); | ||
| 6 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 7 | has DnsName => (is => 'ro', isa => 'Str', request_name => 'dnsName', traits => ['NameInRequest']); | ||
| 8 | has HealthCheckPath => (is => 'ro', isa => 'Str', request_name => 'healthCheckPath', traits => ['NameInRequest']); | ||
| 9 | has InstanceHealthSummary => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::InstanceHealthSummary]', request_name => 'instanceHealthSummary', traits => ['NameInRequest']); | ||
| 10 | has InstancePort => (is => 'ro', isa => 'Int', request_name => 'instancePort', traits => ['NameInRequest']); | ||
| 11 | has IpAddressType => (is => 'ro', isa => 'Str', request_name => 'ipAddressType', traits => ['NameInRequest']); | ||
| 12 | has Location => (is => 'ro', isa => 'Paws::Lightsail::ResourceLocation', request_name => 'location', traits => ['NameInRequest']); | ||
| 13 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 14 | has Protocol => (is => 'ro', isa => 'Str', request_name => 'protocol', traits => ['NameInRequest']); | ||
| 15 | has PublicPorts => (is => 'ro', isa => 'ArrayRef[Int]', request_name => 'publicPorts', traits => ['NameInRequest']); | ||
| 16 | has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest']); | ||
| 17 | has State => (is => 'ro', isa => 'Str', request_name => 'state', traits => ['NameInRequest']); | ||
| 18 | has SupportCode => (is => 'ro', isa => 'Str', request_name => 'supportCode', traits => ['NameInRequest']); | ||
| 19 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 20 | has TlsCertificateSummaries => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::LoadBalancerTlsCertificateSummary]', request_name => 'tlsCertificateSummaries', traits => ['NameInRequest']); | ||
| 21 | |||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::Lightsail::LoadBalancer | ||
| 29 | |||
| 30 | =head1 USAGE | ||
| 31 | |||
| 32 | This class represents one of two things: | ||
| 33 | |||
| 34 | =head3 Arguments in a call to a service | ||
| 35 | |||
| 36 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 37 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 38 | |||
| 39 | As an example, if Att1 is expected to be a Paws::Lightsail::LoadBalancer object: | ||
| 40 | |||
| 41 | $service_obj->Method(Att1 => { Arn => $value, ..., TlsCertificateSummaries => $value }); | ||
| 42 | |||
| 43 | =head3 Results returned from an API call | ||
| 44 | |||
| 45 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::LoadBalancer object: | ||
| 46 | |||
| 47 | $result = $service_obj->Method(...); | ||
| 48 | $result->Att1->Arn | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | Describes the Lightsail load balancer. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Arn => Str | ||
| 58 | |||
| 59 | The Amazon Resource Name (ARN) of the load balancer. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ConfigurationOptions => L<Paws::Lightsail::LoadBalancerConfigurationOptions> | ||
| 63 | |||
| 64 | A string to string map of the configuration options for your load | ||
| 65 | balancer. Valid values are listed below. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 CreatedAt => Str | ||
| 69 | |||
| 70 | The date when your load balancer was created. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 DnsName => Str | ||
| 74 | |||
| 75 | The DNS name of your Lightsail load balancer. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 HealthCheckPath => Str | ||
| 79 | |||
| 80 | The path you specified to perform your health checks. If no path is | ||
| 81 | specified, the load balancer tries to make a request to the default | ||
| 82 | (root) page. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 InstanceHealthSummary => ArrayRef[L<Paws::Lightsail::InstanceHealthSummary>] | ||
| 86 | |||
| 87 | An array of InstanceHealthSummary objects describing the health of the | ||
| 88 | load balancer. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 InstancePort => Int | ||
| 92 | |||
| 93 | The port where the load balancer will direct traffic to your Lightsail | ||
| 94 | instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port | ||
| 95 | 443. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 IpAddressType => Str | ||
| 99 | |||
| 100 | The IP address type of the load balancer. | ||
| 101 | |||
| 102 | The possible values are C<ipv4> for IPv4 only, and C<dualstack> for | ||
| 103 | IPv4 and IPv6. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 Location => L<Paws::Lightsail::ResourceLocation> | ||
| 107 | |||
| 108 | The AWS Region where your load balancer was created (e.g., | ||
| 109 | C<us-east-2a>). Lightsail automatically creates your load balancer | ||
| 110 | across Availability Zones. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 Name => Str | ||
| 114 | |||
| 115 | The name of the load balancer (e.g., C<my-load-balancer>). | ||
| 116 | |||
| 117 | |||
| 118 | =head2 Protocol => Str | ||
| 119 | |||
| 120 | The protocol you have enabled for your load balancer. Valid values are | ||
| 121 | below. | ||
| 122 | |||
| 123 | You can't just have C<HTTP_HTTPS>, but you can have just C<HTTP>. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 PublicPorts => ArrayRef[Int] | ||
| 127 | |||
| 128 | An array of public port settings for your load balancer. For HTTP, use | ||
| 129 | port 80. For HTTPS, use port 443. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 ResourceType => Str | ||
| 133 | |||
| 134 | The resource type (e.g., C<LoadBalancer>. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 State => Str | ||
| 138 | |||
| 139 | The status of your load balancer. Valid values are below. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 SupportCode => Str | ||
| 143 | |||
| 144 | The support code. Include this code in your email to support when you | ||
| 145 | have questions about your Lightsail load balancer. This code enables | ||
| 146 | our support team to look up your Lightsail information more easily. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>] | ||
| 150 | |||
| 151 | The tag keys and optional values for the resource. For more information | ||
| 152 | about tags in Lightsail, see the Lightsail Dev Guide | ||
| 153 | (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). | ||
| 154 | |||
| 155 | |||
| 156 | =head2 TlsCertificateSummaries => ArrayRef[L<Paws::Lightsail::LoadBalancerTlsCertificateSummary>] | ||
| 157 | |||
| 158 | An array of LoadBalancerTlsCertificateSummary objects that provide | ||
| 159 | additional information about the SSL/TLS certificates. For example, if | ||
| 160 | C<true>, the certificate is attached to the load balancer. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head1 SEE ALSO | ||
| 165 | |||
| 166 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 167 | |||
| 168 | =head1 BUGS and CONTRIBUTIONS | ||
| 169 | |||
| 170 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 171 | |||
| 172 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 173 | |||
| 174 | =cut | ||
| 175 |