« blib/lib/Paws/CodeStarConnections.pm
↑ Summary
blib/lib/Paws/CodeStarConnections/CreateConnection.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeStarConnections::Connection; | ||
| 3 | use Moose; | ||
| 4 | has ConnectionArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has ConnectionName => (is => 'ro', isa => 'Str'); | ||
| 6 | has ConnectionStatus => (is => 'ro', isa => 'Str'); | ||
| 7 | has HostArn => (is => 'ro', isa => 'Str'); | ||
| 8 | has OwnerAccountId => (is => 'ro', isa => 'Str'); | ||
| 9 | has ProviderType => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CodeStarConnections::Connection | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CodeStarConnections::Connection object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { ConnectionArn => $value, ..., ProviderType => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeStarConnections::Connection object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->ConnectionArn | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | A resource that is used to connect third-party source providers with | ||
| 42 | services like AWS CodePipeline. | ||
| 43 | |||
| 44 | Note: A connection created through CloudFormation, the CLI, or the SDK | ||
| 45 | is in `PENDING` status by default. You can make its status `AVAILABLE` | ||
| 46 | by updating the connection in the console. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 ConnectionArn => Str | ||
| 52 | |||
| 53 | The Amazon Resource Name (ARN) of the connection. The ARN is used as | ||
| 54 | the connection reference when the connection is shared between AWS | ||
| 55 | services. | ||
| 56 | |||
| 57 | The ARN is never reused if the connection is deleted. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ConnectionName => Str | ||
| 61 | |||
| 62 | The name of the connection. Connection names must be unique in an AWS | ||
| 63 | user account. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ConnectionStatus => Str | ||
| 67 | |||
| 68 | The current status of the connection. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 HostArn => Str | ||
| 72 | |||
| 73 | The Amazon Resource Name (ARN) of the host associated with the | ||
| 74 | connection. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 OwnerAccountId => Str | ||
| 78 | |||
| 79 | The identifier of the external provider where your third-party code | ||
| 80 | repository is configured. For Bitbucket, this is the account ID of the | ||
| 81 | owner of the Bitbucket repository. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 ProviderType => Str | ||
| 85 | |||
| 86 | The name of the external provider where your third-party code | ||
| 87 | repository is configured. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeStarConnections> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |