| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Neptune::DBClusterEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has CustomEndpointType => (is => 'ro', isa => 'Str'); | ||
| 5 | has DBClusterEndpointArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has DBClusterEndpointIdentifier => (is => 'ro', isa => 'Str'); | ||
| 7 | has DBClusterEndpointResourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 9 | has Endpoint => (is => 'ro', isa => 'Str'); | ||
| 10 | has EndpointType => (is => 'ro', isa => 'Str'); | ||
| 11 | has ExcludedMembers => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 12 | has StaticMembers => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 13 | has Status => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Neptune::DBClusterEndpoint | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Neptune::DBClusterEndpoint object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { CustomEndpointType => $value, ..., Status => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Neptune::DBClusterEndpoint object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->CustomEndpointType | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | This data type represents the information you need to connect to an | ||
| 46 | Amazon Neptune DB cluster. This data type is used as a response element | ||
| 47 | in the following actions: | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | C<CreateDBClusterEndpoint> | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | C<DescribeDBClusterEndpoints> | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | C<ModifyDBClusterEndpoint> | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<DeleteDBClusterEndpoint> | ||
| 66 | |||
| 67 | =back | ||
| 68 | |||
| 69 | For the data structure that represents Amazon Neptune DB instance | ||
| 70 | endpoints, see C<Endpoint>. | ||
| 71 | |||
| 72 | =head1 ATTRIBUTES | ||
| 73 | |||
| 74 | |||
| 75 | =head2 CustomEndpointType => Str | ||
| 76 | |||
| 77 | The type associated with a custom endpoint. One of: C<READER>, | ||
| 78 | C<WRITER>, C<ANY>. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 DBClusterEndpointArn => Str | ||
| 82 | |||
| 83 | The Amazon Resource Name (ARN) for the endpoint. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 DBClusterEndpointIdentifier => Str | ||
| 87 | |||
| 88 | The identifier associated with the endpoint. This parameter is stored | ||
| 89 | as a lowercase string. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 DBClusterEndpointResourceIdentifier => Str | ||
| 93 | |||
| 94 | A unique system-generated identifier for an endpoint. It remains the | ||
| 95 | same for the whole life of the endpoint. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 DBClusterIdentifier => Str | ||
| 99 | |||
| 100 | The DB cluster identifier of the DB cluster associated with the | ||
| 101 | endpoint. This parameter is stored as a lowercase string. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 Endpoint => Str | ||
| 105 | |||
| 106 | The DNS address of the endpoint. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 EndpointType => Str | ||
| 110 | |||
| 111 | The type of the endpoint. One of: C<READER>, C<WRITER>, C<CUSTOM>. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 ExcludedMembers => ArrayRef[Str|Undef] | ||
| 115 | |||
| 116 | List of DB instance identifiers that aren't part of the custom endpoint | ||
| 117 | group. All other eligible instances are reachable through the custom | ||
| 118 | endpoint. Only relevant if the list of static members is empty. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 StaticMembers => ArrayRef[Str|Undef] | ||
| 122 | |||
| 123 | List of DB instance identifiers that are part of the custom endpoint | ||
| 124 | group. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 Status => Str | ||
| 128 | |||
| 129 | The current status of the endpoint. One of: C<creating>, C<available>, | ||
| 130 | C<deleting>, C<inactive>, C<modifying>. The C<inactive> state applies | ||
| 131 | to an endpoint that cannot be used for a certain kind of cluster, such | ||
| 132 | as a C<writer> endpoint for a read-only secondary cluster in a global | ||
| 133 | database. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head1 SEE ALSO | ||
| 138 | |||
| 139 | This class forms part of L<Paws>, describing an object used in L<Paws::Neptune> | ||
| 140 | |||
| 141 | =head1 BUGS and CONTRIBUTIONS | ||
| 142 | |||
| 143 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 144 | |||
| 145 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 146 | |||
| 147 | =cut | ||
| 148 |