« blib/lib/Paws/CodeStarConnections/GetHostOutput.pm
↑ Summary
blib/lib/Paws/CodeStarConnections/ListConnections.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeStarConnections::Host; | ||
| 3 | use Moose; | ||
| 4 | has HostArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has Name => (is => 'ro', isa => 'Str'); | ||
| 6 | has ProviderEndpoint => (is => 'ro', isa => 'Str'); | ||
| 7 | has ProviderType => (is => 'ro', isa => 'Str'); | ||
| 8 | has Status => (is => 'ro', isa => 'Str'); | ||
| 9 | has StatusMessage => (is => 'ro', isa => 'Str'); | ||
| 10 | has VpcConfiguration => (is => 'ro', isa => 'Paws::CodeStarConnections::VpcConfiguration'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::CodeStarConnections::Host | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::CodeStarConnections::Host object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { HostArn => $value, ..., VpcConfiguration => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeStarConnections::Host object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->HostArn | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | A resource that represents the infrastructure where a third-party | ||
| 43 | provider is installed. The host is used when you create connections to | ||
| 44 | an installed third-party provider type, such as GitHub Enterprise | ||
| 45 | Server. You create one host for all connections to that provider. | ||
| 46 | |||
| 47 | A host created through the CLI or the SDK is in `PENDING` status by | ||
| 48 | default. You can make its status `AVAILABLE` by setting up the host in | ||
| 49 | the console. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 HostArn => Str | ||
| 55 | |||
| 56 | The Amazon Resource Name (ARN) of the host. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Name => Str | ||
| 60 | |||
| 61 | The name of the host. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 ProviderEndpoint => Str | ||
| 65 | |||
| 66 | The endpoint of the infrastructure where your provider type is | ||
| 67 | installed. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 ProviderType => Str | ||
| 71 | |||
| 72 | The name of the installed provider to be associated with your | ||
| 73 | connection. The host resource represents the infrastructure where your | ||
| 74 | provider type is installed. The valid provider type is GitHub | ||
| 75 | Enterprise Server. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Status => Str | ||
| 79 | |||
| 80 | The status of the host, such as PENDING, AVAILABLE, | ||
| 81 | VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and | ||
| 82 | VPC_CONFIG_FAILED_INITIALIZATION. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 StatusMessage => Str | ||
| 86 | |||
| 87 | The status description for the host. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 VpcConfiguration => L<Paws::CodeStarConnections::VpcConfiguration> | ||
| 91 | |||
| 92 | The VPC configuration provisioned for the host. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeStarConnections> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |