| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::DBProxy; | ||
| 3 | use Moose; | ||
| 4 | has Auth => (is => 'ro', isa => 'ArrayRef[Paws::RDS::UserAuthConfigInfo]'); | ||
| 5 | has CreatedDate => (is => 'ro', isa => 'Str'); | ||
| 6 | has DBProxyArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has DBProxyName => (is => 'ro', isa => 'Str'); | ||
| 8 | has DebugLogging => (is => 'ro', isa => 'Bool'); | ||
| 9 | has Endpoint => (is => 'ro', isa => 'Str'); | ||
| 10 | has EngineFamily => (is => 'ro', isa => 'Str'); | ||
| 11 | has IdleClientTimeout => (is => 'ro', isa => 'Int'); | ||
| 12 | has RequireTLS => (is => 'ro', isa => 'Bool'); | ||
| 13 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 14 | has Status => (is => 'ro', isa => 'Str'); | ||
| 15 | has UpdatedDate => (is => 'ro', isa => 'Str'); | ||
| 16 | has VpcId => (is => 'ro', isa => 'Str'); | ||
| 17 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 18 | has VpcSubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::RDS::DBProxy | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::RDS::DBProxy object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { Auth => $value, ..., VpcSubnetIds => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBProxy object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->Auth | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | The data structure representing a proxy managed by the RDS Proxy. | ||
| 51 | |||
| 52 | This data type is used as a response element in the | ||
| 53 | C<DescribeDBProxies> action. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Auth => ArrayRef[L<Paws::RDS::UserAuthConfigInfo>] | ||
| 59 | |||
| 60 | One or more data structures specifying the authorization mechanism to | ||
| 61 | connect to the associated RDS DB instance or Aurora DB cluster. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 CreatedDate => Str | ||
| 65 | |||
| 66 | The date and time when the proxy was first created. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 DBProxyArn => Str | ||
| 70 | |||
| 71 | The Amazon Resource Name (ARN) for the proxy. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 DBProxyName => Str | ||
| 75 | |||
| 76 | The identifier for the proxy. This name must be unique for all proxies | ||
| 77 | owned by your Amazon Web Services account in the specified Amazon Web | ||
| 78 | Services Region. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 DebugLogging => Bool | ||
| 82 | |||
| 83 | Whether the proxy includes detailed information about SQL statements in | ||
| 84 | its logs. This information helps you to debug issues involving SQL | ||
| 85 | behavior or the performance and scalability of the proxy connections. | ||
| 86 | The debug information includes the text of SQL statements that you | ||
| 87 | submit through the proxy. Thus, only enable this setting when needed | ||
| 88 | for debugging, and only when you have security measures in place to | ||
| 89 | safeguard any sensitive information that appears in the logs. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 Endpoint => Str | ||
| 93 | |||
| 94 | The endpoint that you can use to connect to the DB proxy. You include | ||
| 95 | the endpoint value in the connection string for a database client | ||
| 96 | application. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 EngineFamily => Str | ||
| 100 | |||
| 101 | The engine family applies to MySQL and PostgreSQL for both RDS and | ||
| 102 | Aurora. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 IdleClientTimeout => Int | ||
| 106 | |||
| 107 | The number of seconds a connection to the proxy can have no activity | ||
| 108 | before the proxy drops the client connection. The proxy keeps the | ||
| 109 | underlying database connection open and puts it back into the | ||
| 110 | connection pool for reuse by later connection requests. | ||
| 111 | |||
| 112 | Default: 1800 (30 minutes) | ||
| 113 | |||
| 114 | Constraints: 1 to 28,800 | ||
| 115 | |||
| 116 | |||
| 117 | =head2 RequireTLS => Bool | ||
| 118 | |||
| 119 | Indicates whether Transport Layer Security (TLS) encryption is required | ||
| 120 | for connections to the proxy. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 RoleArn => Str | ||
| 124 | |||
| 125 | The Amazon Resource Name (ARN) for the IAM role that the proxy uses to | ||
| 126 | access Amazon Secrets Manager. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 Status => Str | ||
| 130 | |||
| 131 | The current status of this proxy. A status of C<available> means the | ||
| 132 | proxy is ready to handle requests. Other values indicate that you must | ||
| 133 | wait for the proxy to be ready, or take some action to resolve an | ||
| 134 | issue. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 UpdatedDate => Str | ||
| 138 | |||
| 139 | The date and time when the proxy was last updated. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 VpcId => Str | ||
| 143 | |||
| 144 | Provides the VPC ID of the DB proxy. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 148 | |||
| 149 | Provides a list of VPC security groups that the proxy belongs to. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 VpcSubnetIds => ArrayRef[Str|Undef] | ||
| 153 | |||
| 154 | The EC2 subnet IDs for the proxy. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head1 SEE ALSO | ||
| 159 | |||
| 160 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 161 | |||
| 162 | =head1 BUGS and CONTRIBUTIONS | ||
| 163 | |||
| 164 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 165 | |||
| 166 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 167 | |||
| 168 | =cut | ||
| 169 |