« blib/lib/Paws/RDS/UserAuthConfig.pm
↑ Summary
blib/lib/Paws/RDS/ValidDBInstanceModificationsMessage.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::UserAuthConfigInfo; | ||
| 3 | use Moose; | ||
| 4 | has AuthScheme => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has IAMAuth => (is => 'ro', isa => 'Str'); | ||
| 7 | has SecretArn => (is => 'ro', isa => 'Str'); | ||
| 8 | has UserName => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::RDS::UserAuthConfigInfo | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::RDS::UserAuthConfigInfo object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { AuthScheme => $value, ..., UserName => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::UserAuthConfigInfo object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->AuthScheme | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Returns the details of authentication used by a proxy to log in as a | ||
| 41 | specific database user. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 AuthScheme => Str | ||
| 47 | |||
| 48 | The type of authentication that the proxy uses for connections from the | ||
| 49 | proxy to the underlying database. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Description => Str | ||
| 53 | |||
| 54 | A user-specified description about the authentication used by a proxy | ||
| 55 | to log in as a specific database user. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 IAMAuth => Str | ||
| 59 | |||
| 60 | Whether to require or disallow Amazon Web Services Identity and Access | ||
| 61 | Management (IAM) authentication for connections to the proxy. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 SecretArn => Str | ||
| 65 | |||
| 66 | The Amazon Resource Name (ARN) representing the secret that the proxy | ||
| 67 | uses to authenticate to the RDS DB instance or Aurora DB cluster. These | ||
| 68 | secrets are stored within Amazon Secrets Manager. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 UserName => Str | ||
| 72 | |||
| 73 | The name of the database user to which the proxy connects. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |