« blib/lib/Paws/Lightsail/CreateKeyPairResult.pm
↑ Summary
blib/lib/Paws/Lightsail/CreateLoadBalancerResult.pm »
| 1 | |||
| 2 | package Paws::Lightsail::CreateLoadBalancer; | ||
| 3 | use Moose; | ||
| 4 | has CertificateAlternativeNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'certificateAlternativeNames' ); | ||
| 5 | has CertificateDomainName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateDomainName' ); | ||
| 6 | has CertificateName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateName' ); | ||
| 7 | has HealthCheckPath => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'healthCheckPath' ); | ||
| 8 | has InstancePort => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'instancePort' , required => 1); | ||
| 9 | has IpAddressType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'ipAddressType' ); | ||
| 10 | has LoadBalancerName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'loadBalancerName' , required => 1); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateLoadBalancer'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::CreateLoadBalancerResult'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Lightsail::CreateLoadBalancer - Arguments for method CreateLoadBalancer on L<Paws::Lightsail> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateLoadBalancer on the | ||
| 29 | L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateLoadBalancer. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateLoadBalancer. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $lightsail = Paws->service('Lightsail'); | ||
| 37 | my $CreateLoadBalancerResult = $lightsail->CreateLoadBalancer( | ||
| 38 | InstancePort => 1, | ||
| 39 | LoadBalancerName => 'MyResourceName', | ||
| 40 | CertificateAlternativeNames => [ 'MyDomainName', ... ], # OPTIONAL | ||
| 41 | CertificateDomainName => 'MyDomainName', # OPTIONAL | ||
| 42 | CertificateName => 'MyResourceName', # OPTIONAL | ||
| 43 | HealthCheckPath => 'Mystring', # OPTIONAL | ||
| 44 | IpAddressType => 'dualstack', # OPTIONAL | ||
| 45 | Tags => [ | ||
| 46 | { | ||
| 47 | Key => 'MyTagKey', # OPTIONAL | ||
| 48 | Value => 'MyTagValue', # OPTIONAL | ||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $Operations = $CreateLoadBalancerResult->Operations; | ||
| 56 | |||
| 57 | # Returns a L<Paws::Lightsail::CreateLoadBalancerResult> object. | ||
| 58 | |||
| 59 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/CreateLoadBalancer> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 CertificateAlternativeNames => ArrayRef[Str|Undef] | ||
| 66 | |||
| 67 | The optional alternative domains and subdomains to use with your | ||
| 68 | SSL/TLS certificate (e.g., C<www.example.com>, C<example.com>, | ||
| 69 | C<m.example.com>, C<blog.example.com>). | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 CertificateDomainName => Str | ||
| 74 | |||
| 75 | The domain name with which your certificate is associated (e.g., | ||
| 76 | C<example.com>). | ||
| 77 | |||
| 78 | If you specify C<certificateDomainName>, then C<certificateName> is | ||
| 79 | required (and vice-versa). | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 CertificateName => Str | ||
| 84 | |||
| 85 | The name of the SSL/TLS certificate. | ||
| 86 | |||
| 87 | If you specify C<certificateName>, then C<certificateDomainName> is | ||
| 88 | required (and vice-versa). | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 HealthCheckPath => Str | ||
| 93 | |||
| 94 | The path you provided to perform the load balancer health check. If you | ||
| 95 | didn't specify a health check path, Lightsail uses the root path of | ||
| 96 | your website (e.g., C<"/">). | ||
| 97 | |||
| 98 | You may want to specify a custom health check path other than the root | ||
| 99 | of your application if your home page loads slowly or has a lot of | ||
| 100 | media or scripting on it. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> InstancePort => Int | ||
| 105 | |||
| 106 | The instance port where you're creating your load balancer. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 IpAddressType => Str | ||
| 111 | |||
| 112 | The IP address type for the load balancer. | ||
| 113 | |||
| 114 | The possible values are C<ipv4> for IPv4 only, and C<dualstack> for | ||
| 115 | IPv4 and IPv6. | ||
| 116 | |||
| 117 | The default value is C<dualstack>. | ||
| 118 | |||
| 119 | Valid values are: C<"dualstack">, C<"ipv4"> | ||
| 120 | |||
| 121 | =head2 B<REQUIRED> LoadBalancerName => Str | ||
| 122 | |||
| 123 | The name of your load balancer. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>] | ||
| 128 | |||
| 129 | The tag keys and optional values to add to the resource during create. | ||
| 130 | |||
| 131 | Use the C<TagResource> action to tag a resource after it's created. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head1 SEE ALSO | ||
| 137 | |||
| 138 | This class forms part of L<Paws>, documenting arguments for method CreateLoadBalancer in L<Paws::Lightsail> | ||
| 139 | |||
| 140 | =head1 BUGS and CONTRIBUTIONS | ||
| 141 | |||
| 142 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 143 | |||
| 144 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 145 | |||
| 146 | =cut | ||
| 147 |