« blib/lib/Paws/RDS/CreateDBParameterGroupResult.pm
↑ Summary
blib/lib/Paws/RDS/CreateDBProxyEndpoint.pm »
| 1 | |||
| 2 | package Paws::RDS::CreateDBProxy; | ||
| 3 | use Moose; | ||
| 4 | has Auth => (is => 'ro', isa => 'ArrayRef[Paws::RDS::UserAuthConfig]', required => 1); | ||
| 5 | has DBProxyName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DebugLogging => (is => 'ro', isa => 'Bool'); | ||
| 7 | has EngineFamily => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has IdleClientTimeout => (is => 'ro', isa => 'Int'); | ||
| 9 | has RequireTLS => (is => 'ro', isa => 'Bool'); | ||
| 10 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 12 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 13 | has VpcSubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBProxy'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CreateDBProxyResponse'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBProxyResult'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::RDS::CreateDBProxy - Arguments for method CreateDBProxy on L<Paws::RDS> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateDBProxy on the | ||
| 31 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateDBProxy. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBProxy. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $rds = Paws->service('RDS'); | ||
| 39 | my $CreateDBProxyResponse = $rds->CreateDBProxy( | ||
| 40 | Auth => [ | ||
| 41 | { | ||
| 42 | AuthScheme => 'SECRETS', # values: SECRETS; OPTIONAL | ||
| 43 | Description => 'MyString', # OPTIONAL | ||
| 44 | IAMAuth => 'DISABLED', # values: DISABLED, REQUIRED; OPTIONAL | ||
| 45 | SecretArn => 'MyString', # OPTIONAL | ||
| 46 | UserName => 'MyString', # OPTIONAL | ||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], | ||
| 50 | DBProxyName => 'MyString', | ||
| 51 | EngineFamily => 'MYSQL', | ||
| 52 | RoleArn => 'MyString', | ||
| 53 | VpcSubnetIds => [ | ||
| 54 | 'MyString', | ||
| 55 | ... # OPTIONAL | ||
| 56 | ], | ||
| 57 | DebugLogging => 1, # OPTIONAL | ||
| 58 | IdleClientTimeout => 1, # OPTIONAL | ||
| 59 | RequireTLS => 1, # OPTIONAL | ||
| 60 | Tags => [ | ||
| 61 | { | ||
| 62 | Key => 'MyString', # OPTIONAL | ||
| 63 | Value => 'MyString', # OPTIONAL | ||
| 64 | }, | ||
| 65 | ... | ||
| 66 | ], # OPTIONAL | ||
| 67 | VpcSecurityGroupIds => [ | ||
| 68 | 'MyString', ... # OPTIONAL | ||
| 69 | ], # OPTIONAL | ||
| 70 | ); | ||
| 71 | |||
| 72 | # Results: | ||
| 73 | my $DBProxy = $CreateDBProxyResponse->DBProxy; | ||
| 74 | |||
| 75 | # Returns a L<Paws::RDS::CreateDBProxyResponse> object. | ||
| 76 | |||
| 77 | 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. | ||
| 78 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBProxy> | ||
| 79 | |||
| 80 | =head1 ATTRIBUTES | ||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> Auth => ArrayRef[L<Paws::RDS::UserAuthConfig>] | ||
| 84 | |||
| 85 | The authorization mechanism that the proxy uses. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> DBProxyName => Str | ||
| 90 | |||
| 91 | The identifier for the proxy. This name must be unique for all proxies | ||
| 92 | owned by your Amazon Web Services account in the specified Amazon Web | ||
| 93 | Services Region. An identifier must begin with a letter and must | ||
| 94 | contain only ASCII letters, digits, and hyphens; it can't end with a | ||
| 95 | hyphen or contain two consecutive hyphens. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 DebugLogging => Bool | ||
| 100 | |||
| 101 | Whether the proxy includes detailed information about SQL statements in | ||
| 102 | its logs. This information helps you to debug issues involving SQL | ||
| 103 | behavior or the performance and scalability of the proxy connections. | ||
| 104 | The debug information includes the text of SQL statements that you | ||
| 105 | submit through the proxy. Thus, only enable this setting when needed | ||
| 106 | for debugging, and only when you have security measures in place to | ||
| 107 | safeguard any sensitive information that appears in the logs. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> EngineFamily => Str | ||
| 112 | |||
| 113 | The kinds of databases that the proxy can connect to. This value | ||
| 114 | determines which database network protocol the proxy recognizes when it | ||
| 115 | interprets network traffic to and from the database. The engine family | ||
| 116 | applies to MySQL and PostgreSQL for both RDS and Aurora. | ||
| 117 | |||
| 118 | Valid values are: C<"MYSQL">, C<"POSTGRESQL"> | ||
| 119 | |||
| 120 | =head2 IdleClientTimeout => Int | ||
| 121 | |||
| 122 | The number of seconds that a connection to the proxy can be inactive | ||
| 123 | before the proxy disconnects it. You can set this value higher or lower | ||
| 124 | than the connection timeout limit for the associated database. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 RequireTLS => Bool | ||
| 129 | |||
| 130 | A Boolean parameter that specifies whether Transport Layer Security | ||
| 131 | (TLS) encryption is required for connections to the proxy. By enabling | ||
| 132 | this setting, you can enforce encrypted TLS connections to the proxy. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> RoleArn => Str | ||
| 137 | |||
| 138 | The Amazon Resource Name (ARN) of the IAM role that the proxy uses to | ||
| 139 | access secrets in Amazon Web Services Secrets Manager. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 144 | |||
| 145 | An optional set of key-value pairs to associate arbitrary data of your | ||
| 146 | choosing with the proxy. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 151 | |||
| 152 | One or more VPC security group IDs to associate with the new proxy. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head2 B<REQUIRED> VpcSubnetIds => ArrayRef[Str|Undef] | ||
| 157 | |||
| 158 | One or more VPC subnet IDs to associate with the new proxy. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head1 SEE ALSO | ||
| 164 | |||
| 165 | This class forms part of L<Paws>, documenting arguments for method CreateDBProxy in L<Paws::RDS> | ||
| 166 | |||
| 167 | =head1 BUGS and CONTRIBUTIONS | ||
| 168 | |||
| 169 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 170 | |||
| 171 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 172 | |||
| 173 | =cut | ||
| 174 |