« blib/lib/Paws/Lightsail/InstanceAccessDetails.pm
↑ Summary
blib/lib/Paws/Lightsail/InstanceHardware.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::InstanceEntry; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZone => (is => 'ro', isa => 'Str', request_name => 'availabilityZone', traits => ['NameInRequest'], required => 1); | ||
| 5 | has InstanceType => (is => 'ro', isa => 'Str', request_name => 'instanceType', traits => ['NameInRequest'], required => 1); | ||
| 6 | has PortInfoSource => (is => 'ro', isa => 'Str', request_name => 'portInfoSource', traits => ['NameInRequest'], required => 1); | ||
| 7 | has SourceName => (is => 'ro', isa => 'Str', request_name => 'sourceName', traits => ['NameInRequest'], required => 1); | ||
| 8 | has UserData => (is => 'ro', isa => 'Str', request_name => 'userData', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Lightsail::InstanceEntry | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Lightsail::InstanceEntry object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { AvailabilityZone => $value, ..., UserData => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::InstanceEntry object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->AvailabilityZone | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Describes the Amazon Elastic Compute Cloud instance and related | ||
| 41 | resources to be created using the C<create cloud formation stack> | ||
| 42 | operation. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> AvailabilityZone => Str | ||
| 48 | |||
| 49 | The Availability Zone for the new Amazon EC2 instance. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> InstanceType => Str | ||
| 53 | |||
| 54 | The instance type (e.g., C<t2.micro>) to use for the new Amazon EC2 | ||
| 55 | instance. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> PortInfoSource => Str | ||
| 59 | |||
| 60 | The port configuration to use for the new Amazon EC2 instance. | ||
| 61 | |||
| 62 | The following configuration options are available: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<DEFAULT> - Use the default firewall settings from the Lightsail | ||
| 69 | instance blueprint. If this is specified, then IPv4 and IPv6 will be | ||
| 70 | configured for the new instance that is created in Amazon EC2. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<INSTANCE> - Use the configured firewall settings from the source | ||
| 75 | Lightsail instance. If this is specified, the new instance that is | ||
| 76 | created in Amazon EC2 will be configured to match the configuration of | ||
| 77 | the source Lightsail instance. For example, if the source instance is | ||
| 78 | configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be | ||
| 79 | configured for the new instance that is created in Amazon EC2. If the | ||
| 80 | source instance is configured for IPv4 only, then only IPv4 will be | ||
| 81 | configured for the new instance that is created in Amazon EC2. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<NONE> - Use the default Amazon EC2 security group. If this is | ||
| 86 | specified, then only IPv4 will be configured for the new instance that | ||
| 87 | is created in Amazon EC2. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<CLOSED> - All ports closed. If this is specified, then only IPv4 will | ||
| 92 | be configured for the new instance that is created in Amazon EC2. | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | If you configured C<lightsail-connect> as a C<cidrListAliases> on your | ||
| 97 | instance, or if you chose to allow the Lightsail browser-based SSH or | ||
| 98 | RDP clients to connect to your instance, that configuration is not | ||
| 99 | carried over to your new Amazon EC2 instance. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> SourceName => Str | ||
| 103 | |||
| 104 | The name of the export snapshot record, which contains the exported | ||
| 105 | Lightsail instance snapshot that will be used as the source of the new | ||
| 106 | Amazon EC2 instance. | ||
| 107 | |||
| 108 | Use the C<get export snapshot records> operation to get a list of | ||
| 109 | export snapshot records that you can use to create a CloudFormation | ||
| 110 | stack. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 UserData => Str | ||
| 114 | |||
| 115 | A launch script you can create that configures a server with additional | ||
| 116 | user data. For example, you might want to run C<apt-get -y update>. | ||
| 117 | |||
| 118 | Depending on the machine image you choose, the command to get software | ||
| 119 | on your instance varies. Amazon Linux and CentOS use C<yum>, Debian and | ||
| 120 | Ubuntu use C<apt-get>, and FreeBSD uses C<pkg>. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |