| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::DBProxyEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has CreatedDate => (is => 'ro', isa => 'Str'); | ||
| 5 | has DBProxyEndpointArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has DBProxyEndpointName => (is => 'ro', isa => 'Str'); | ||
| 7 | has DBProxyName => (is => 'ro', isa => 'Str'); | ||
| 8 | has Endpoint => (is => 'ro', isa => 'Str'); | ||
| 9 | has IsDefault => (is => 'ro', isa => 'Bool'); | ||
| 10 | has Status => (is => 'ro', isa => 'Str'); | ||
| 11 | has TargetRole => (is => 'ro', isa => 'Str'); | ||
| 12 | has VpcId => (is => 'ro', isa => 'Str'); | ||
| 13 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | has VpcSubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::RDS::DBProxyEndpoint | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::RDS::DBProxyEndpoint object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { CreatedDate => $value, ..., VpcSubnetIds => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBProxyEndpoint object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->CreatedDate | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | The data structure representing an endpoint associated with a DB proxy. | ||
| 47 | RDS automatically creates one endpoint for each DB proxy. For Aurora DB | ||
| 48 | clusters, you can associate additional endpoints with the same DB | ||
| 49 | proxy. These endpoints can be read/write or read-only. They can also | ||
| 50 | reside in different VPCs than the associated DB proxy. | ||
| 51 | |||
| 52 | This data type is used as a response element in the | ||
| 53 | C<DescribeDBProxyEndpoints> operation. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 CreatedDate => Str | ||
| 59 | |||
| 60 | The date and time when the DB proxy endpoint was first created. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 DBProxyEndpointArn => Str | ||
| 64 | |||
| 65 | The Amazon Resource Name (ARN) for the DB proxy endpoint. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 DBProxyEndpointName => Str | ||
| 69 | |||
| 70 | The name for the DB proxy endpoint. An identifier must begin with a | ||
| 71 | letter and must contain only ASCII letters, digits, and hyphens; it | ||
| 72 | can't end with a hyphen or contain two consecutive hyphens. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 DBProxyName => Str | ||
| 76 | |||
| 77 | The identifier for the DB proxy that is associated with this DB proxy | ||
| 78 | endpoint. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 Endpoint => Str | ||
| 82 | |||
| 83 | The endpoint that you can use to connect to the DB proxy. You include | ||
| 84 | the endpoint value in the connection string for a database client | ||
| 85 | application. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 IsDefault => Bool | ||
| 89 | |||
| 90 | A value that indicates whether this endpoint is the default endpoint | ||
| 91 | for the associated DB proxy. Default DB proxy endpoints always have | ||
| 92 | read/write capability. Other endpoints that you associate with the DB | ||
| 93 | proxy can be either read/write or read-only. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Status => Str | ||
| 97 | |||
| 98 | The current status of this DB proxy endpoint. A status of C<available> | ||
| 99 | means the endpoint is ready to handle requests. Other values indicate | ||
| 100 | that you must wait for the endpoint to be ready, or take some action to | ||
| 101 | resolve an issue. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 TargetRole => Str | ||
| 105 | |||
| 106 | A value that indicates whether the DB proxy endpoint can be used for | ||
| 107 | read/write or read-only operations. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 VpcId => Str | ||
| 111 | |||
| 112 | Provides the VPC ID of the DB proxy endpoint. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 116 | |||
| 117 | Provides a list of VPC security groups that the DB proxy endpoint | ||
| 118 | belongs to. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 VpcSubnetIds => ArrayRef[Str|Undef] | ||
| 122 | |||
| 123 | The EC2 subnet IDs for the DB proxy endpoint. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head1 SEE ALSO | ||
| 128 | |||
| 129 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 130 | |||
| 131 | =head1 BUGS and CONTRIBUTIONS | ||
| 132 | |||
| 133 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 134 | |||
| 135 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 136 | |||
| 137 | =cut | ||
| 138 |