« blib/lib/Paws/RDS/ModifyDBParameterGroup.pm
↑ Summary
blib/lib/Paws/RDS/ModifyDBProxyEndpoint.pm »
| 1 | |||
| 2 | package Paws::RDS::ModifyDBProxy; | ||
| 3 | use Moose; | ||
| 4 | has Auth => (is => 'ro', isa => 'ArrayRef[Paws::RDS::UserAuthConfig]'); | ||
| 5 | has DBProxyName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DebugLogging => (is => 'ro', isa => 'Bool'); | ||
| 7 | has IdleClientTimeout => (is => 'ro', isa => 'Int'); | ||
| 8 | has NewDBProxyName => (is => 'ro', isa => 'Str'); | ||
| 9 | has RequireTLS => (is => 'ro', isa => 'Bool'); | ||
| 10 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 11 | has SecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDBProxy'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ModifyDBProxyResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyDBProxyResult'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::RDS::ModifyDBProxy - Arguments for method ModifyDBProxy on L<Paws::RDS> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method ModifyDBProxy on the | ||
| 29 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 30 | as arguments to method ModifyDBProxy. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBProxy. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $rds = Paws->service('RDS'); | ||
| 37 | my $ModifyDBProxyResponse = $rds->ModifyDBProxy( | ||
| 38 | DBProxyName => 'MyString', | ||
| 39 | Auth => [ | ||
| 40 | { | ||
| 41 | AuthScheme => 'SECRETS', # values: SECRETS; OPTIONAL | ||
| 42 | Description => 'MyString', | ||
| 43 | IAMAuth => 'DISABLED', # values: DISABLED, REQUIRED; OPTIONAL | ||
| 44 | SecretArn => 'MyString', | ||
| 45 | UserName => 'MyString', | ||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | DebugLogging => 1, # OPTIONAL | ||
| 50 | IdleClientTimeout => 1, # OPTIONAL | ||
| 51 | NewDBProxyName => 'MyString', # OPTIONAL | ||
| 52 | RequireTLS => 1, # OPTIONAL | ||
| 53 | RoleArn => 'MyString', # OPTIONAL | ||
| 54 | SecurityGroups => [ 'MyString', ... ], # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $DBProxy = $ModifyDBProxyResponse->DBProxy; | ||
| 59 | |||
| 60 | # Returns a L<Paws::RDS::ModifyDBProxyResponse> object. | ||
| 61 | |||
| 62 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBProxy> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Auth => ArrayRef[L<Paws::RDS::UserAuthConfig>] | ||
| 69 | |||
| 70 | The new authentication settings for the C<DBProxy>. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> DBProxyName => Str | ||
| 75 | |||
| 76 | The identifier for the C<DBProxy> to modify. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 DebugLogging => Bool | ||
| 81 | |||
| 82 | Whether the proxy includes detailed information about SQL statements in | ||
| 83 | its logs. This information helps you to debug issues involving SQL | ||
| 84 | behavior or the performance and scalability of the proxy connections. | ||
| 85 | The debug information includes the text of SQL statements that you | ||
| 86 | submit through the proxy. Thus, only enable this setting when needed | ||
| 87 | for debugging, and only when you have security measures in place to | ||
| 88 | safeguard any sensitive information that appears in the logs. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 IdleClientTimeout => Int | ||
| 93 | |||
| 94 | The number of seconds that a connection to the proxy can be inactive | ||
| 95 | before the proxy disconnects it. You can set this value higher or lower | ||
| 96 | than the connection timeout limit for the associated database. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 NewDBProxyName => Str | ||
| 101 | |||
| 102 | The new identifier for the C<DBProxy>. An identifier must begin with a | ||
| 103 | letter and must contain only ASCII letters, digits, and hyphens; it | ||
| 104 | can't end with a hyphen or contain two consecutive hyphens. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 RequireTLS => Bool | ||
| 109 | |||
| 110 | Whether Transport Layer Security (TLS) encryption is required for | ||
| 111 | connections to the proxy. By enabling this setting, you can enforce | ||
| 112 | encrypted TLS connections to the proxy, even if the associated database | ||
| 113 | doesn't use TLS. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 RoleArn => Str | ||
| 118 | |||
| 119 | The Amazon Resource Name (ARN) of the IAM role that the proxy uses to | ||
| 120 | access secrets in Amazon Web Services Secrets Manager. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 SecurityGroups => ArrayRef[Str|Undef] | ||
| 125 | |||
| 126 | The new list of security groups for the C<DBProxy>. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, documenting arguments for method ModifyDBProxy in L<Paws::RDS> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |